-
-**API 시크릿은 절대로 외부에 노출되어서는 안되는 값**입니다.\
-실제 구현에서 액세스 토큰 발급은 꼭 서버사이드에서 해주세요.
+ 1. [관리자 콘솔 `상점・계정 관리` 화면](https://admin.portone.io/merchant) 접속
+ 2. `내 식별코드・API Keys` 버튼 클릭
-
+
+
+ **API 시크릿은 절대로 외부에 노출되어서는 안 되는 값**입니다.\
+ 실제 구현에서 액세스 토큰 발급은 꼭 서버 사이드에서 해주세요.
+
-
액세스 토큰 발급 받기
+
액세스 토큰 발급 받기
- 호출
+ 호출
-import getTokenImage from "./_assets/v1auth/get-token.png";
-
-
-
-
-포트원 REST API 서버는 **Google Public NTP**의 시간과 동기화되고 있습니다.
-
-
+
-
-하위 상점 연동을 할 경우 액세스 토큰을 발급받을 때 **Agent 계정**의 **API 키** 와 **API 시크릿**을 사용해야 합니다.
+
+ 포트원 REST API 서버는 **Google Public NTP**의 시간과 동기화되고 있습니다.
+
-[Agency & Tier 란?](/docs/ko/tip/agency-and-tier)
-
-
+
+ 하위 상점 연동을 할 경우 액세스 토큰을 발급받을 때 **Agent 계정**의 **API 키** 와 **API 시크릿**을 사용해야 합니다.
+ [Agency & Tier 란?](/docs/ko/tip/agency-and-tier)
+
-
액세스 토큰 사용하기
-
-발급받은 액세스 토큰은 다른 API를 호출할 때\
-`Authorization` 헤더에 `Bearer <액세스 토큰>` 형식의 값을 넣어주면 됩니다.
-
-자세한 내용은 [MDN - HTTP 인증 문서](https://developer.mozilla.org/ko/docs/Web/HTTP/Authentication)를 참고해주세요.
+
액세스 토큰 사용하기
-import useImage from "./_assets/v1auth/use.png";
-
-
+ 발급받은 액세스 토큰은 다른 API를 호출할 때\
+ `Authorization` 헤더에 `Bearer <액세스 토큰>` 형식의 값을 넣어주면 됩니다.
-
-하위 상점 연동을 할 경우 포트원 API 호출시 `Tier` 헤더에 하위 상점 티어 코드를 입력해야 합니다.
+ 자세한 내용은 [MDN - HTTP 인증 문서](https://developer.mozilla.org/ko/docs/Web/HTTP/Authentication)를 참고해주세요.
-[Agency & Tier 란?](/docs/ko/tip/agency-and-tier)
-
-import tierImage from "./_assets/v1auth/tier.png";
+
-
+
+ 하위 상점 연동을 할 경우 포트원 API 호출시 `Tier` 헤더에 하위 상점 티어 코드를 입력해야 합니다.
-
+ [Agency & Tier 란?](/docs/ko/tip/agency-and-tier)
+
+
-
액세스 토큰 만료기한 연장
+
액세스 토큰 만료기한 연장
-만료된 액세스 토큰으로 API를 호출하면 `401 Unauthorized` 응답을 받습니다.\
-액세스 토큰의 만료기한은 발행시간부터 **30분**입니다.
-
-- 기존 액세스 토큰이 만료되기 전 를 다시 호출했을 경우
- - 기존 액세스 토큰이 반환됩니다.\
- **만료기한이 1분 안쪽으로 남았을 때** 요청했다면 기존 액세스 토큰의 만료시간이 **5분 연장**됩니다.
-- 기존 액세스 토큰이 만료된 다음 를 다시 호출했을 경우
- - 새로운 액세스 토큰이 반환됩니다.
-
-import reuseImage from "./_assets/v1auth/reuse.svg";
+ 만료된 액세스 토큰으로 API를 호출하면 `401 Unauthorized` 응답을 받습니다.\
+ 액세스 토큰의 만료 기한은 발행시간부터 **30분**입니다.
-
+ - 기존 액세스 토큰이 만료되기 전 를 다시 호출했을 경우
+ - 기존 액세스 토큰이 반환됩니다.\
+ **만료 기한이 1분 안쪽으로 남았을 때** 요청했다면 기존 액세스 토큰의 만료 기한이 **5분 연장**됩니다.
-
-액세스 토큰의 재사용과 만료기한 5분 연장 동작방식은 다음과 같은 상황을 고려해서 설계되었습니다.
+ - 기존 액세스 토큰이 만료된 다음 를 다시 호출했을 경우
+ - 새로운 액세스 토큰이 반환됩니다.
-- 한 고객사에서 여러 대의 웹서버가 동시에 경쟁적으로 REST API(`/users/getToken`)를 호출하는 상황
-- 한 고객사에서 여러 대의 웹서버가 시간 동기화 되어있지 않은 상황
+
-
+
+ 액세스 토큰의 재사용과 만료기한 5분 연장 동작방식은 다음과 같은 상황을 고려해서 설계되었습니다.
+ - 한 고객사에서 여러 대의 웹서버가 동시에 경쟁적으로 REST API(`/users/getToken`)를 호출하는 상황
+ - 한 고객사에서 여러 대의 웹서버가 시간 동기화 되어있지 않은 상황
+
diff --git a/src/content/blog/2024-02/v2-oom.mdx b/src/content/blog/2024-02/v2-oom.mdx
index bbd107127..731d71661 100644
--- a/src/content/blog/2024-02/v2-oom.mdx
+++ b/src/content/blog/2024-02/v2-oom.mdx
@@ -8,6 +8,7 @@ thumbnail: ./_assets/v2-oom/0.png
---
import Figure from "~/components/Figure.astro";
+
import image0 from "./_assets/v2-oom/0.png";
import image1 from "./_assets/v2-oom/1.png";
import image2 from "./_assets/v2-oom/2.png";
diff --git a/src/content/blog/2024-02/v2-zio.mdx b/src/content/blog/2024-02/v2-zio.mdx
index e89cc844f..12989e76e 100644
--- a/src/content/blog/2024-02/v2-zio.mdx
+++ b/src/content/blog/2024-02/v2-zio.mdx
@@ -519,12 +519,12 @@ ZIO는 그러한 조건에 잘 부합하는 Effect System이었고 현재까지
이러한 요구사항을 만족하기 위해 신중한 고민을 거쳐 의사결정을 했고, 그렇게 탄생한 포트원 V2 모듈은 수많은 디지털 커머스 회사들과 함께할 준비를 마쳤습니다.
포트원 V2에서는 커머스 회사들이 결제와 관련된 고민을 덜 수 있도록 멋진 기능들을 많이 출시할 예정이니, 앞으로 포트원 V2 모듈의 행보를 지켜봐주세요!
-[scala]: \(https://scala-lang.org/\)
+[scala]: https://scala-lang.org/
-[why-fp-matters]: \(https://www.cs.kent.ac.uk/people/staff/dat/miranda/whyfp90.pdf\)
+[why-fp-matters]: https://www.cs.kent.ac.uk/people/staff/dat/miranda/whyfp90.pdf
-[for-comprehension]: \(https://docs.scala-lang.org/tour/for-comprehensions.html\)
+[for-comprehension]: https://docs.scala-lang.org/tour/for-comprehensions.html
-[ast]: \(https://en.wikipedia.org/wiki/Abstract_syntax_tree\)
+[ast]: https://en.wikipedia.org/wiki/Abstract_syntax_tree
-[zio]: \(https://zio.dev/\)
+[zio]: https://zio.dev/
diff --git a/src/content/blog/2024-03/tgs.mdx b/src/content/blog/2024-03/tgs.mdx
index e181c5aaf..2b8d0ee23 100644
--- a/src/content/blog/2024-03/tgs.mdx
+++ b/src/content/blog/2024-03/tgs.mdx
@@ -35,45 +35,45 @@ V1을 완전히 버리고 V2로 넘어가는 것이 아니기 때문에 하나
- 카카오페이 결제 파라미터
-|Name |타입 |필수여부|설명 |
+| Name | 타입 |필수여부| 설명 |
|:----------------:|:--------:|:------:|:--------------------------------------------------------------------------------------------------------------------:|
-|cid |String |O |가맹점 코드, 10자 |
-|cid\_secret |String |X |가맹점 코드 인증키, 24자, 숫자와 영문 소문자 조합 |
-|partner\_order\_id|String |O |가맹점 주문번호, 최대 100자 |
-|partner\_user\_id |String |O |가맹점 회원 id, 최대 100자 |
-|item\_name |String |O |상품명, 최대 100자 |
-|item\_code |String |X |상품코드, 최대 100자 |
-|quantity |Integer |O |상품 수량 |
-|total\_amount |Integer |O |상품 총액 |
-|tax\_free\_amount |Integer |O |상품 비과세 금액 |
-|vat\_amount |Integer |X |상품 부가세 금액 값을 보내지 않을 경우 다음과 같이 VAT 자동 계산 (상품총액 - 상품 비과세 금액)/11 : 소숫점 이하 반올림|
-|green\_deposit |Integer |X |컵 보증금 |
-|approval\_url |String |O |결제 성공 시 redirect url, 최대 255자 |
-|cancel\_url |String |O |결제 취소 시 redirect url, 최대 255자 |
-|fail\_url |String |O |결제 실패 시 redirect url, 최대 255자 |
-|available\_cards |JSON Array|X |결제 수단으로써 사용 허가할 카드사를 지정해야 하는 경우 사용 |
+| cid | String | O | 가맹점 코드, 10자 |
+| cid\_secret | String | X | 가맹점 코드 인증키, 24자, 숫자와 영문 소문자 조합 |
+|partner\_order\_id| String | O | 가맹점 주문번호, 최대 100자 |
+| partner\_user\_id| String | O | 가맹점 회원 id, 최대 100자 |
+| item\_name | String | O | 상품명, 최대 100자 |
+| item\_code | String | X | 상품코드, 최대 100자 |
+| quantity | Integer | O | 상품 수량 |
+| total\_amount | Integer | O | 상품 총액 |
+| tax\_free\_amount| Integer | O | 상품 비과세 금액 |
+| vat\_amount | Integer | X |상품 부가세 금액 값을 보내지 않을 경우 다음과 같이 VAT 자동 계산 (상품총액 - 상품 비과세 금액)/11 : 소숫점 이하 반올림|
+| green\_deposit | Integer | X | 컵 보증금 |
+| approval\_url | String | O | 결제 성공 시 redirect url, 최대 255자 |
+| cancel\_url | String | O | 결제 취소 시 redirect url, 최대 255자 |
+| fail\_url | String | O | 결제 실패 시 redirect url, 최대 255자 |
+| available\_cards |JSON Array| X | 결제 수단으로써 사용 허가할 카드사를 지정해야 하는 경우 사용 |
- 네이버페이 결제 파라미터
-|Name |타입 |필수여부|설명 |
+| Name | 타입 |필수여부| 설명 |
|:-----------------------:|:-----:|:------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
-|merchantPayKey |String |O |가맹점 주문내역 확인 가능한 가맹점 결제번호 또는 주문번호를 전달해야 합니다 |
-|merchantPayTransactionKey|String | |가맹점 주문내역 히스토리 확인이 가능한 가맹점 결제 트랜잭션 번호 또는 주문 트랜잭션 번호를 전달해야 합니다. |
-|merchantUserKey |String | |가맹점의 사용자 키(개인 아이디와 같은 개인정보 데이터는 제외하여 전달해야 합니다) |
-|productName |String |O |대표 상품명. 예: 장미의 이름 외 1건(X), 장미의 이름(O) |
-|productCount |Number |O |상품 수량 예: A 상품 2개 + B 상품 1개의 경우 productCount 3으로 전달 |
-|totalPayAmount |Number |O |총 결제 금액. 최소 결제금액은 10원 |
-|taxScopeAmount |Number |O |과세 대상 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
-|taxExScopeAmount |Number |O |면세 대상 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
-|environmentDepositAmount |Number | |1회용 컵에 담은 상품의 결제건인 경우에만 필수값이며, 그 외에는 전달할 필요가 없습니다. 컵 보증금 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
-|returnUrl |String |O |결제 인증 결과 전달 URL, 결제 완료 후 이동할 URL(returnUrl + 가맹점 파라미터 전달이 가능합니다) 네이버페이는 결제 작업 완료 후, 고객사가 등록한 returnUrl로 리디렉션을 수행합니다 고객사는 이를 활용하여 내부 처리를 수행하거나 구매자에게 결제 결과 화면을 노출할 수 있습니다 |
-|purchaserName |String | |구매자 성명. 결제 상품이 보험 및 위험 업종 등인 경우에만 필수 값입니다. 그 외에는 전달할 필요가 없습니다 |
-|purchaserBirthday |String | |구매자 생년월일(yyyymmdd). 결제 상품이 보험 및 위험 업종 등인 경우에만 필수 값입니다. 그 외에는 전달할 필요가 없습니다 |
-|extraDeduction |Boolean| |도서 / 공연 / 영화 소득공제 대상 여부. 문화체육관광부에서 인증한 소득공제 제공 사업자가 대상 상품을 판매하는 경우 필수 값입니다. 해당 파라미터를 사용하기 위해서는 별도 요청을 주셔야 합니다. true : 대상, false : 비 대상 |
-|useCfmYmdt |String | |이용완료일(yyyymmdd) 가맹점 타입이 이용완료일 정산 또는 이용완료일 포인트 적립인 경우 필수 해당 값을 기준으로 이용완료일 정산의 경우 '정산기준일' 또는 이용완료일 포인트 적립인 경우 '포인트적립 기준일'이 지정됩니다. 이용완료일은 반드시 결제일과 같거나 결제일 이후여야 하며, 이용완료일이 결제일자 이전으로 적용될 경우 에러(InvalidUseCfmYmdt)가 발생됩니다. 이용완료일이 결제일자 기준으로 1년을 초과할 경우 별도 에러가 발생되지는 않으나 전달한 이용완료일(useCfmYmdt) 값이 결제일자 +365일로 조정 처리됩니다.|
-|merchantExtraParameter |String | |가맹점 자체적으로 추가 구분값으로 활용 가능한 별도의 예비 필드 (개인 아이디와 같은 개인정보 데이터는 제외하여 전달해야 합니다) |
-|productItems |Array |O |productItem 배열 |
-|subMerchantInfo |Object | |하부가맹점 정보. PG 업종 가맹점인 경우에만 필수값입니다 |
+| merchantPayKey | String| O | 가맹점 주문내역 확인 가능한 가맹점 결제번호 또는 주문번호를 전달해야 합니다 |
+|merchantPayTransactionKey| String| | 가맹점 주문내역 히스토리 확인이 가능한 가맹점 결제 트랜잭션 번호 또는 주문 트랜잭션 번호를 전달해야 합니다. |
+| merchantUserKey | String| | 가맹점의 사용자 키(개인 아이디와 같은 개인정보 데이터는 제외하여 전달해야 합니다) |
+| productName | String| O | 대표 상품명. 예: 장미의 이름 외 1건(X), 장미의 이름(O) |
+| productCount | Number| O | 상품 수량 예: A 상품 2개 + B 상품 1개의 경우 productCount 3으로 전달 |
+| totalPayAmount | Number| O | 총 결제 금액. 최소 결제금액은 10원 |
+| taxScopeAmount | Number| O | 과세 대상 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
+| taxExScopeAmount | Number| O | 면세 대상 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
+| environmentDepositAmount| Number| | 1회용 컵에 담은 상품의 결제건인 경우에만 필수값이며, 그 외에는 전달할 필요가 없습니다. 컵 보증금 금액. 과세 대상 금액 + 면세 대상 금액 + 컵 보증금 금액 (옵션) = 총 결제 금액 |
+| returnUrl | String| O | 결제 인증 결과 전달 URL, 결제 완료 후 이동할 URL(returnUrl + 가맹점 파라미터 전달이 가능합니다) 네이버페이는 결제 작업 완료 후, 가맹점이 등록한 returnUrl로 리디렉션을 수행합니다 가맹점은 이를 활용하여 내부 처리를 수행하거나 구매자에게 결제 결과 화면을 노출할 수 있습니다 |
+| purchaserName | String| | 구매자 성명. 결제 상품이 보험 및 위험 업종 등인 경우에만 필수 값입니다. 그 외에는 전달할 필요가 없습니다 |
+| purchaserBirthday | String| | 구매자 생년월일(yyyymmdd). 결제 상품이 보험 및 위험 업종 등인 경우에만 필수 값입니다. 그 외에는 전달할 필요가 없습니다 |
+| extraDeduction |Boolean| | 도서 / 공연 / 영화 소득공제 대상 여부. 문화체육관광부에서 인증한 소득공제 제공 사업자가 대상 상품을 판매하는 경우 필수 값입니다. 해당 파라미터를 사용하기 위해서는 별도 요청을 주셔야 합니다. true : 대상, false : 비 대상 |
+| useCfmYmdt | String| |이용완료일(yyyymmdd) 가맹점 타입이 이용완료일 정산 또는 이용완료일 포인트 적립인 경우 필수 해당 값을 기준으로 이용완료일 정산의 경우 '정산기준일' 또는 이용완료일 포인트 적립인 경우 '포인트적립 기준일'이 지정됩니다. 이용완료일은 반드시 결제일과 같거나 결제일 이후여야 하며, 이용완료일이 결제일자 이전으로 적용될 경우 에러(InvalidUseCfmYmdt)가 발생됩니다. 이용완료일이 결제일자 기준으로 1년을 초과할 경우 별도 에러가 발생되지는 않으나 전달한 이용완료일(useCfmYmdt) 값이 결제일자 +365일로 조정 처리됩니다.|
+| merchantExtraParameter | String| | 가맹점 자체적으로 추가 구분값으로 활용 가능한 별도의 예비 필드 (개인 아이디와 같은 개인정보 데이터는 제외하여 전달해야 합니다) |
+| productItems | Array | O | productItem 배열 |
+| subMerchantInfo | Object| | 하부가맹점 정보. PG 업종 가맹점인 경우에만 필수값입니다 |
위처럼 같은 기능을 하는 인터페이스임에도 PG사에 따라 파라미터 명과 파라미터 타입, 필수 파라미터 목록 모두 상이한 것을 볼 수 있습니다.
심지어 사용하는 통신 프로토콜마저 PG사마다 상이하죠.
@@ -214,7 +214,7 @@ Typed error를 적용함으로써 예시 코드의 `pay()` 함수에선 `AmountT
```kotlin
interface Example {
fun pay(): Effect
-
+
sealed interface PayError {
data object AmountTooBig: PayError
data object InvalidCardInfo: PayError
diff --git a/src/content/docs/_redir.yaml b/src/content/docs/_redir.yaml
index dd4f2222d..307869d8b 100644
--- a/src/content/docs/_redir.yaml
+++ b/src/content/docs/_redir.yaml
@@ -167,6 +167,11 @@
- old: /ko/api-v2/platform
new: /ko/platform/api
+- old: /ko/api-v2/billing_key
+ new: /ko/api-v2/billing-key
+- old: /ko/api-v2/cash_receipt
+ new: /ko/api-v2/cash-receipt
+
- old: /ko/ready/2-pg/payment-gateway/nice-v2
new: /ko/ready/2-pg/payment-gateway/nice
diff --git a/src/content/docs/en/api/api/api.mdx b/src/content/docs/en/api/api/api.mdx
index 8d3526591..13cdab12b 100644
--- a/src/content/docs/en/api/api/api.mdx
+++ b/src/content/docs/en/api/api/api.mdx
@@ -4,406 +4,386 @@ description: ''
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Requests a payment by billing key (customer\_uid).
+## Requests a payment by billing key (customer\_uid).
-
-You can use the
+
+ You can use the
-**customer_uid**
+ **customer\_uid**
- obtained via Get billing key API or PG payment window to request a non-authenticated payment.
+ obtained via Get billing key API or PG payment window to request a non-authenticated payment.
+
-
+ ### Parameters
-### Parameters
+ #### Body
-#### Body
+
+
+ **Billing key**
+
+
-
-
+
+
+ **Order ID**
+
+
-**Billing key**
+
+ **Currency**
+
-
+
+
+ **Payment amount**
+
+
-
-
-
+
+ **Tax free amount**
+
-**Order ID**
+
+
+ **Product name**
+
+
-
+
+ **Customer name**
+
-
-
-**Currency**
+
+ **Customer email**
+
-
-
-
+
+ **Customer phone**
+
-**Payment amount**
+
+ **Customer address**
+
-
+
+ **Customer zip code**
+
-
-
-**Tax free amount**
+
+ **Number of installment months**
+
-
-
-
+
+ **Whether or not there are interest-free installments paid by merchants**
+
-**Product name**
+
+ **Option to use credit card points**
+
-
+
+ **Custom data**
+
-
-
-**Customer name**
+
+ **Webhook URL for success notification**
+
-
-
-**Customer email**
+
+ **Customer's browser (PC) IP**
+
-
-
-**Customer phone**
+ ### Responses
-
-
-**Customer address**
+
+
+
+ **`code`** **\*** **integer**
-
-
-**Customer zip code**
+ **Response code**
-
-
-**Number of installment months**
+ 0: success, Not 0: check the message
-
+ **`message`** **\*** **string**
-
-
-**Whether or not there are interest-free installments paid by merchants**
+ **Response message**
-
-
-**Option to use credit card points**
+ A non-zero code includes a message like 'Invalid payment info'.
-
-
-**Custom data**
+ **`response`** **(PaymentAnnotation, optional)**
+
+
-
-
-**Webhook URL for success notification**
+
+
+ **`code`** **\*** **integer**
-
+ **`Response code`**
-
-
-**Customer's browser (PC) IP**
+ 0: success, Not 0: check the message
-
+ **`message`** **\*** **string**
-### Responses
+ **Response message**
-
-
-
-**`code`** **\***** ****integer**
+ A non-zero code includes a message like 'Invalid payment info.
-**Response code**
+ **`imp_uid`** \* **string**
-0: success, Not 0: check the message
+ **i'mport payment transaction UID**
-**`message`** **\***** ****string**
+ **`merchant_uid`** **\*** **string**
-**Response message**
+ **Order ID**
-A non-zero code includes a message like 'Invalid payment info'.
+ **`pay_method`** **\*** **string**
-**`response`** **(PaymentAnnotation, optional)**
+ **Payment method code**
-
-
+ **`channel`** **\*** **string**
-
-
-**`code`** **\***** ****integer**
+ **Payment environment code**
-**`Response code`**
+ - pc: (authenticated) PC
+ - mobile: (authenticated) mobile
+ - api: recurring or non-authenticated
-0: success, Not 0: check the message
+ **`pg_provider`** **\*** **string**
-**`message`** **\***** ****string**
+ **PG code**
-**Response message**
+ ---
-A non-zero code includes a message like 'Invalid payment info.
+ **`emb_pg_provider`** **\*** **string**
-**`imp_uid`** \* **string**
+ **Hub-type PG code**
-**i'mport payment transaction UID**
+ **`pg_tid`** **\*** **string**
-**`merchant_uid`** **\***** ****string**
+ **PG transaction ID**
-**Order ID**
+ **`pg_id`** **\*** **string**
-**`pay_method`** **\***** ****string**
+ **PG MID**
-**Payment method code**
+ **`escrow`** **boolean**
-**`channel`** **\***** ****string**
+ **Indicates an escrow payment**
-**Payment environment code**
+ **`apply_num`** **string**
-- pc**:** (authenticated) PC
-- mobile: (authenticated) mobile
-- api: recurring or non-authenticated
+ **Credit card approval number**
-**`pg_provider`** **\***** ****string**
+ **`bank_code`** **string**
-**PG code**
+ **Bank code**
----
+ **`bank_name`** **string**
-**`emb_pg_provider`** **\***** ****string**
+ **Bank name**
-**Hub-type PG code**
+ ---
-**`pg_tid`** **\*** **string**
+ **`card_code`** **string**
-**PG transaction ID**
+ **Credit card code (KFTC Credit Card Codes:** [**link**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) )
-**`pg_id`** **\***** ****string**
+ **`card_name`** **string**
-**PG MID**
+ **Credit card name**
-**`escrow`** **boolean**
+ **`card_quota`** **integer**
-**Indicates an escrow payment**
+ **Number of installments (0 means one-off)**
-**`apply_num`** **string**
+ **`card_number`** **string**
-**Credit card approval number**
+ **Masked credit card number**
-**`bank_code`** **string**
+ ---
-**Bank code**
+ **`card_type`** **string**
-**`bank_name`** **string**
+ **Credit card type code**
-**Bank name**
+ - 0: credit
+ - 1: check
----
+ **`vbank_code`** **string**
-**`card_code`** **string**
+ **Virtual account bank code (refer to image below)**
-**Credit card code (KFTC Credit Card Codes:** [**link**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) )
+ ---
-**`card_name`** **string**
+ **`vbank_name`** **string**
-**Credit card name**
+ **Refund virtual account**
-**`card_quota`** **integer**
+ **`vbank_holder`** **string**
-**Number of installments (0 means one-off)**
+ **Refund virtual account holder**
-**`card_number`** **string**
+ **`vbank_date`** **string**
-**Masked credit card number**
+ **Refund virtual account expiration (UNIX timestamp)**
----
+ **`vbank_issued_at`** **string**
-**`card_type`** **string**
+ **Refund virtual account created at (UNIX timestamp)**
-**Credit card type code**
+ **`name`** **string**
-- 0: credit
-- 1: check
+ **Product name**
-**`vbank_code`** **string**
+ **`amount`** **\*** **integer**
-**Virtual account bank code (refer to image below)**
+ **Order (payment) amount**
----
+ **`cancel_amount`** **integer**
-**`vbank_name`** **string**
+ **Cancelled amount**
-**Refund virtual account**
+ **`currency`** **string**
-**`vbank_holder`** **string**
+ **Currency**
-**Refund virtual account holder**
+ - USD
+ - KRW
+ - EUR
-**`vbank_date`** **string**
+ ---
-**Refund virtual account expiration (UNIX timestamp)**
+ **`buyer_name`** **string**
-**`vbank_issued_at`** **string**
+ **Customer name**
-**Refund virtual account created at (UNIX timestamp)**
+ **`buyer_email`** **string**
-**`name`** **string**
+ **Customer email**
-**Product name**
+ **`buyer_tel`** **string**
-**`amount`** **\*** **integer**
+ **Customer phone**
-**Order (payment) amount**
-
-**`cancel_amount`** **integer**
-
-**Cancelled amount**
-
-**`currency`** **string**
-
-**Currency**
-
-- USD
-- KRW
-- EUR
-
----
+ **`buyer_addr`** **string**
-**`buyer_name`** **string**
+ **Customer address**
-**Customer name**
+ **`buyer_postcode`** **string**
-**`buyer_email`** **string**
+ **Customer zip code**
-**Customer email**\
+ **`custom_data`** **string**
-**`buyer_tel`** **string**
+ **echo data as JSON string**
-**Customer phone**
+ **`user_agent`** **string**
-**`buyer_addr`** **string**
+ **UserAgent of the device where payment is initiated**
-**Customer address**
+ **`status`** **\*** **string**
-**`buyer_postcode`** **string**
+ **Payment status code**
-**Customer zip code**
+ - ready
+ - paid
+ - cancelled
+ - failed
-**`custom_data`** **string**
+ **`started_at`** **\*** **string**
-**echo data as JSON string**
+ **Payment started at (UNIX timestamp)**
-**`user_agent`** **string**
+ **`paid_at`** **\*** **string**
-**UserAgent of the device where payment is initiated**
+ **Payment completed at (UNIX timestamp)**
-**`status`** **\***** ****string**
+ **`failed_at`** **\*** **string**
-**Payment status code**
+ **Payment failed at (UNIX timestamp)**
-- ready
-- paid
-- cancelled
-- failed
+ **`cancelled_at`** **\*** **string**
-**`started_at`** **\*** **string**
+ **Payment cancelled at (UNIX timestamp)**
-**Payment started at (UNIX timestamp)**
+ **`fail_reason`** **string**
-**`paid_at`** **\***** ****string**
+ **Reason for failure**
-**Payment completed at (UNIX timestamp)**\
+ **`cancel_reason`** **string**
-**`failed_at`** **\***** ****string**
+ **Reason for cancellation**
-**Payment failed at (UNIX timestamp)**
+ **`receipt_url`** **string**
-**`cancelled_at`** **\***** ****string**
+ **Credit card receipt URL**
-**Payment cancelled at (UNIX timestamp)**
+ **`cash_receipt_issued`** **boolean**
-**`fail_reason`** **string**
+ **Option to automatically issue cash receipt**
-**Reason for failure**
+ **`customer_uid`** **string**
-**`cancel_reason`** **string**
+ **customer\_uid related to the payment transaction**
-**Reason for cancellation**
+ **`customer_uid_usage`** **string**
-**`receipt_url`** **string**
+ **customer\_uid use code**
-**Credit card receipt URL**
+ - payment.scheduled: scheduled payment
+ - payment: payment
+ - issue: billing key issuance
-**`cash_receipt_issued` ****boolean**
+ **`cancel_history`** **(Array\[PaymentCancelAnnotation], optional):**
-**Option to automatically issue cash receipt**
+ **`Cancellation/partial cancellation history`**
+
+
-**`customer_uid`** **string**
+
+
+ **cancel\_history array \[]**
-**customer\_uid related to the payment transaction**
+ **`pg_tid`** **\*** **string**
-**`customer_uid_usage`** **string**
+ **PG cancellation transaction ID**
-**customer\_uid use code**
+ **`amount`** **\*** **integer**
-- payment.scheduled: scheduled payment
-- payment: payment
-- issue**: billing key issuance**
+ **Cancelled amount**
-**`cancel_history`** **(Array\[PaymentCancelAnnotation], optional):**
+ **`cancelled_at`** **\*** **string**
-**`Cancellation/partial cancellation history`**
+ **Cancelled at (UNIX timestamp)**
-
-
+ **`reason`** **\*** **string(256)**
-
-
-**cancel\_history array \[]**
+ **Reason for cancellation**
-**`pg_tid`** **\***** ****string**
+ **`receipt_url`** **\*** **string(300)**
-**PG cancellation transaction ID**
-
-**`amount`** **\*** **integer**
-
-**Cancelled amount**
-
-**`cancelled_at`** **\*** **string**
-
-**Cancelled at (UNIX timestamp)**
-
-**`reason`** **\*** **string(256)**
-
-**Reason for cancellation**
-
-**`receipt_url`** **\***** ****string(300)**
-
-**Cancellation receipt URL. Availability varies by PG.**
-
-
-
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
+ **Cancellation receipt URL. Availability varies by PG.**
+
+
+
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
### **Key request parameter description**
@@ -429,7 +409,7 @@ A non-zero code includes a message like 'Invalid payment info.
>
> Required for Paymentwall PG
-> **`buyer_name` ****string**
+> **`buyer_name`** **string**
>
> **Customer name**
>
@@ -442,79 +422,77 @@ A non-zero code includes a message like 'Invalid payment info.
> Required for Paymentwall PG
-
+
+ ```json
+ {
+ "code": 0,
+ "message": "string",
+ "response": {
+ "company": "string",
+ "invoice": "string",
+ "sent_at": 0,
+ "applied_at": 0
+ }
}
-}
-```
-
+ ```
-**Swagger Test Link**
-
-[**https://api.iamport.kr/#!/escrow.logis/escrow_logis_get**](https://api.iamport.kr/#!/escrow.logis/escrow_logis_get)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/escrow.logis/escrow\_logis\_get**](https://api.iamport.kr/#!/escrow.logis/escrow_logis_get)
diff --git a/src/content/docs/en/api/escrow-api/readme.mdx b/src/content/docs/en/api/escrow-api/readme.mdx
index 349fd1a2f..b5feb1f59 100644
--- a/src/content/docs/en/api/escrow-api/readme.mdx
+++ b/src/content/docs/en/api/escrow-api/readme.mdx
@@ -5,7 +5,7 @@ description: Learn about escrow service API.
import ContentRef from "~/components/gitbook/ContentRef.astro";
-### Escrow API currently supports the following PGs:
+## Escrow API currently supports the following PGs:
- KG Inicis
- NHN KCP
diff --git a/src/content/docs/en/api/escrow-api/update-delivery-info-api.mdx b/src/content/docs/en/api/escrow-api/update-delivery-info-api.mdx
index 03d1e4979..ac73acf55 100644
--- a/src/content/docs/en/api/escrow-api/update-delivery-info-api.mdx
+++ b/src/content/docs/en/api/escrow-api/update-delivery-info-api.mdx
@@ -4,138 +4,118 @@ description: ""
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
+import Hint from "~/components/Hint.astro";
-### Updates delivery info for an escrow transaction.
+## Updates delivery info for an escrow transaction.
-
+
+ ```json
+ {
+ "code": 0,
+ "message": "string",
+ "response": {
+ "imp_uid": "string",
+ "merchant_uid": "string",
+ "pg_tid": "string",
+ "pg_provider": "string",
+ "name": "string",
+ "gender": "string",
+ "birth": 0,
+ "birthday": "string",
+ "foreigner": true,
+ "phone": "string",
+ "carrier": "SKT",
+ "certified": true,
+ "certified_at": 0,
+ "unique_key": "string",
+ "unique_in_site": "string",
+ "origin": "string",
+ "foreigner_v2": true
+ }
}
-}
-```
-
+ ```
-**Swagger Test Link**
-
-[**https://api.iamport.kr/#!/certifications/getCertification**](https://api.iamport.kr/#!/certifications/getCertification)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/certifications/getCertification**](https://api.iamport.kr/#!/certifications/getCertification)
diff --git a/src/content/docs/en/api/identity-verification-api/request-identity-verification-api.mdx b/src/content/docs/en/api/identity-verification-api/request-identity-verification-api.mdx
index 1b0c80010..82e0cca4c 100644
--- a/src/content/docs/en/api/identity-verification-api/request-identity-verification-api.mdx
+++ b/src/content/docs/en/api/identity-verification-api/request-identity-verification-api.mdx
@@ -4,145 +4,134 @@ description: ''
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Sends OTP number via SMS confirming the user's identity based on the submitted personal information.
+## Sends OTP number via SMS confirming the user's identity based on the submitted personal information.
-
-If the user's personal information is passed to the API and verified by the carrier, an OTP (6-digit verification number) is sent to the user via SMS. This is only supported by some merchants who have been pre-approved by the carrier, and is currently only being serviced through **Danal**.
-
-You can call the API by directly entering the name, date of birth + 7th digit of social security number, mobile phone number, and carrier information from the merchant. If the transmitted personal information is correct, a verification code SMS is sent to the mobile phone.
-
-When you receive an HTTP Status 200 response, it contains the verification ID (`imp_uid`) in the response body. To complete the verification process, call the /certifications/otp/confirm/\{imp\_uid} API with the OTP number.
-
-
-
-### Parameters
-
-#### Body
+
+ If the user's personal information is passed to the API and verified by the carrier, an OTP (6-digit verification number) is sent to the user via SMS. This is only supported by some merchants who have been pre-approved by the carrier, and is currently only being serviced through **Danal**.
-
-
+ You can call the API by directly entering the name, date of birth + 7th digit of social security number, mobile phone number, and carrier information from the merchant. If the transmitted personal information is correct, a verification code SMS is sent to the mobile phone.
-**User name**
+ When you receive an HTTP Status 200 response, it contains the verification ID (`imp_uid`) in the response body. To complete the verification process, call the /certifications/otp/confirm/\{imp\_uid} API with the OTP number.
+
-
+ ### Parameters
-
-
- **Mobile number**
+ #### Body
-May contain special characters.
+
+
+ **User name**
+
+
-
-
-**DOB**
+
+ **Mobile number**
-**`YYYYMMDD (6-digit)`**
+ May contain special characters.
+
-May contain special characters.
+
+ **DOB**
-
-
-**Gender code**
+ **`YYYYMMDD (6-digit)`**
-7th digit of 13-digit social security number
+ May contain special characters.
+
-
-
-**Carrier code**
+
+ **Gender code**
-**`SKT`**
+ 7th digit of 13-digit social security number
+
-**`KT`**
+
+ **Carrier code**
-**`LGT`**
+ **`SKT`**
-
-
-**Budget phone?**
+ **`KT`**
-
-
-**Merchant service name**
+ **`LGT`**
+
-
-
-**Order ID**
+
+ **Budget phone?**
+
-
-
-**PG code**
+
+ **Merchant service name**
+
-
+
+ **Order ID**
+
-### Responses
+
+ **PG code**
+
-
-
-
-**`code`** **\*** **integer**
+ ### Responses
-**Response code**
+
+
+
+ **`code`** **\*** **integer**
-0: success, Not 0: check the message
+ **Response code**
-**`message`** **\*** **string**
+ 0: success, Not 0: check the message
-**Response message**
+ **`message`** **\*** **string**
-A non-zero code includes a message like 'Invalid payment info'.
+ **Response message**
-**response ** **(CertificationOTPAnnotation, optional)**
+ A non-zero code includes a message like 'Invalid payment info'.
-
-
+ **response** **(CertificationOTPAnnotation, optional)**
+
+
-
-
-**`imp_uid *`` `** **`String`**
+
+
+ **`imp_uid *`` `** **`String`**
-**`i'mport verification ID`**
+ **`i'mport verification ID`**
+
+
+
-
-
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
### **Key request parameter description**
@@ -178,23 +167,21 @@ A non-zero code includes a message like 'Invalid payment info'.
> **danal.\{Merchant ID}**
-
+
+ ```json
+ {
+ "code": 0,
+ "message": "string",
+ "response": {
+ "imp_uid": "string"
+ }
}
-}
-```
-
+ ```
-**Swagger Test Link**
-
-[**https://api.iamport.kr/#!/certifications/requestOTP**](https://api.iamport.kr/#!/certifications/requestOTP)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/certifications/requestOTP**](https://api.iamport.kr/#!/certifications/requestOTP)
diff --git a/src/content/docs/en/api/import-api-overview.mdx b/src/content/docs/en/api/import-api-overview.mdx
index 95be69fb4..934c4663f 100644
--- a/src/content/docs/en/api/import-api-overview.mdx
+++ b/src/content/docs/en/api/import-api-overview.mdx
@@ -6,41 +6,41 @@ description: Get an overview of the i'mport API.
import Figure from "~/components/Figure.astro";
import Hint from "~/components/Hint.astro";
-### Learn how to configure HTTP header in i'mport API call.
+## Learn how to configure HTTP header in i'mport API call.
-1. Call [**/users/getToken**](rest-api-access-token) with **API Key** & **API secret** to get an **`access_token`**.\
+1. Call [**/users/getToken**](rest-api-access-token) with **API Key** & **API secret**
+ to get an **`access_token`**.
-2. In the API call, include the **`access_token`** as **`Authorization:`****`access_token`** or **`X-ImpTokenHeader:`****`access_token`** in the HTTP header.
+2. In the API call, include the **`access_token`** as **`Authorization:`****`access_token`**
+ or **`X-ImpTokenHeader:`****`access_token`** in the HTTP header.
-**Content-Type**
+ **Content-Type**
-API Content-Type supported in i'mport is:
-
-**Application.json;charset=UTF-8**
+ API Content-Type supported in i'mport is:
+ **Application.json;charset=UTF-8**
-**Agency Merchant**
-
-Sub-merchants must specify the following in the **`HTTP Header`** and use the **Agent account's** **`API key`** and **`Secret`** to call the i'mport API.
+ **Agency Merchant**
-- **`"Tier" : "`****`Tier code`**(Sub-merchant Tier Code)"
+ Sub-merchants must specify the following in the **`HTTP Header`** and use the **Agent account's** **`API key`**
+ and **`Secret`** to call the i'mport API.
+ - **`"Tier" : "`****`Tier code`**(Sub-merchant Tier Code)"
### API specification
-To check the detailed specification for i'mport API response, select the **HTTP Status ****200** response as shown below.
+To check the detailed specification for i'mport API response, select the **HTTP Status** **200** response as shown below.
-**API Swagger site**
-
-i'mport supports the Swagger API Specification.
+ **API Swagger site**
-[**https://api.iamport.kr**](https://api.iamport.kr)
+ i'mport supports the Swagger API Specification.
+ [**https://api.iamport.kr**](https://api.iamport.kr)
diff --git a/src/content/docs/en/api/miscellaneous-api/benepia-point/get-points-api.mdx b/src/content/docs/en/api/miscellaneous-api/benepia-point/get-points-api.mdx
index df54def39..31433054b 100644
--- a/src/content/docs/en/api/miscellaneous-api/benepia-point/get-points-api.mdx
+++ b/src/content/docs/en/api/miscellaneous-api/benepia-point/get-points-api.mdx
@@ -4,120 +4,106 @@ description: 베네피아 포인트를 단건 조회 합니다.
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Gets Benepia points using user's Benepia account ID and password through KCP.
+## Gets Benepia points using user's Benepia account ID and password through KCP.
-
-Requires KCP site code.
-
-
-
-### Parameters
-
-#### Body
-
-
-
-
-**Benepia account ID**
+
+ Requires KCP site code.
+
-
+ ### Parameters
-
-
-
+ #### Body
-**Benepia account password**
+
+
+ **Benepia account ID**
+
+
-
+
+
+ **Benepia account password**
+
+
-
-
-**PG code**
+
+ **PG code**
-If there are multiple KCP PG settings, specify as **kcp.\{KCP site code}**. If omitted, the KCP pg setting in Admin console is used.
+ If there are multiple KCP PG settings, specify as **kcp.\{KCP site code}**. If omitted, the KCP pg setting in Admin console is used.
+
-
+ ### Responses
-### Responses
+
+
+
+ **`code`** **\*** **integer**
-
-
-
-**`code`** **\***** ****integer**
+ **Response code**
-**Response code**
+ 0: success, Not 0: check the message
-0: success, Not 0: check the message
+ **`message`** **\*** **string**
-**`message`** **\***** ****string**
+ **Response message**
-**Response message**
+ A non-zero code includes a message like 'Invalid payment info'.
-A non-zero code includes a message like 'Invalid payment info'.
+ **`response`` `****`(BenepiaPointAnnotation, optional)`**
+
+
-**`response`` `****`(BenepiaPointAnnotation, optional)`**
+
+
+ **`point`****`*`****`integer`**
-
-
+ **`Benepia points`**
+
+
+
-
-
-**`point`****`*`****`integer`**
-
-**`Benepia points`**
-
-
-
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
-
+
+ ```json
+ {
+ "code": 0,
+ "message": "string",
+ "response": {
+ "merchant_uid": "string",
+ "amount": 0
+ }
}
-}
-```
-
+ ```
-**Swagger Test Link**
-
-[**https://api.iamport.kr/#!/payments.validation/editPreparePayment**](https://api.iamport.kr/#!/payments.validation/editPreparePayment)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/payments.validation/editPreparePayment**](https://api.iamport.kr/#!/payments.validation/editPreparePayment)
diff --git a/src/content/docs/en/api/rest-api-access-token.mdx b/src/content/docs/en/api/rest-api-access-token.mdx
index 7c9c5504d..9f8efc7ed 100644
--- a/src/content/docs/en/api/rest-api-access-token.mdx
+++ b/src/content/docs/en/api/rest-api-access-token.mdx
@@ -4,22 +4,24 @@ description: Learn how to get an access token.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Access token is required to make an i'mport REST API request.
+## Access token is required to make an i'mport REST API request.
To get access to private resources, such as payment information, you must obtain an access token and
include it in the i'mport REST API request.
-### Get an access token
+### Get an access token
-Request access token from server-side
-
-If you **request for access token from the client-side**, the **`REST API Key`****` ``and`** **`REST API Secret`** are **exposed to public creating a potential security vulnerability**. Therefore, you **must request for access token from the server-side.**
+ Request access token from server-side
+ If you **request for access token from the client-side**,
+ the **`REST API Key`** **and** **`REST API Secret`**
+ are **exposed to public creating a potential security vulnerability**.
+ Therefore, you **must request for access token from the server-side.**
### **STEP 01.** Request access code
@@ -31,60 +33,58 @@ to get an access token as follows:
-
-```python title="server-side"
- curl -H "Content-Type: application/json" POST -d '{"imp_key": "REST API key", "imp_secret":"REST API Secret"}' https://api.iamport.kr/users/getToken
-```
-
-
-
-
-```javascript title="server-side"
-// Request access token
- axios({
- url: "https://api.iamport.kr/users/getToken",
- // POST method
- method: "post",
- // "Content-Type": "application/json"
- headers: { "Content-Type": "application/json" },
- data: {
- // REST API key
- imp_key: "imp_apikey",
- // REST API Secret
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f"
- }
- });
-```
-
-
-
-
-```python
-import requests
-import json
-
-def getTokenApi(path):
- API_HOST = "https://api.iamport.kr"
- url = API_HOST + path
-
- headers = {'Content-Type': 'application/json', 'charset': 'UTF-8', 'Accept': '*/*'}
- body = {
- "imp_key": "", # REST API Key
- "imp_secret": "" # REST API Secret
- }
- try:
- response = requests.post(url, headers=headers, data=json.dumps(body, ensure_ascii=False, indent="\t"))
- return response
- except Exception as ex:
-
-res=getTokenApi("/users/getToken") # API call
-json_object=json.loads(res.text) # Convert to JSON object
-TokenVal = json_object['response']['access_token'] # Parse the token
-
-print(TokenVal)
-```
-
-
+
+ ```sh title="server-side"
+ curl -H "Content-Type: application/json" POST -d '{"imp_key": "REST API key", "imp_secret":"REST API Secret"}' https://api.iamport.kr/users/getToken
+ ```
+
+
+
+ ```ts title="server-side"
+ // Request access token
+ axios({
+ url: "https://api.iamport.kr/users/getToken",
+ // POST method
+ method: "post",
+ // "Content-Type": "application/json"
+ headers: { "Content-Type": "application/json" },
+ data: {
+ // REST API key
+ imp_key: "imp_apikey",
+ // REST API Secret
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f",
+ },
+ });
+ ```
+
+
+
+ ```python
+ import requests
+ import json
+
+ def getTokenApi(path):
+ API_HOST = "https://api.iamport.kr"
+ url = API_HOST + path
+
+ headers = {'Content-Type': 'application/json', 'charset': 'UTF-8', 'Accept': '*/*'}
+ body = {
+ "imp_key": "", # REST API Key
+ "imp_secret": "" # REST API Secret
+ }
+ try:
+ response = requests.post(url, headers=headers, data=json.dumps(body, ensure_ascii=False, indent="\t"))
+ return response
+ except Exception as ex:
+
+ res=getTokenApi("/users/getToken") # API call
+ json_object=json.loads(res.text) # Convert to JSON object
+ TokenVal = json_object['response']['access_token'] # Parse the token
+
+ print(TokenVal)
+ ```
+
### **STEP 02.** Get access token
@@ -93,21 +93,20 @@ Get the access token from the response as follows:
```json title="Response"
{
- "code": 0,
- "message": null,
- "response":{
- "access_token": "a9ace025c90c0da2161075da6ddd3492a2fca776", // access token
- "now": 1512446940, // i'mport REST API server's timestamp
- "expired_at": 1512448740, // token's expiration (UNIX timestamp, KST)
- },
+ "code": 0,
+ "message": null,
+ "response":{
+ "access_token": "a9ace025c90c0da2161075da6ddd3492a2fca776", // access token
+ "now": 1512446940, // i'mport REST API server's timestamp
+ "expired_at": 1512448740 // token's expiration (UNIX timestamp, KST)
}
+}
```
-**Standard NTP Server**
-
-The i'mport REST API server synchronizes with the standard time using **Google Public NTP**.
+ **Standard NTP Server**
+ The i'mport REST API server synchronizes with the standard time using **Google Public NTP**.
### **STEP 03.** Using access token
@@ -119,36 +118,35 @@ format:
> Authorization: **Bearer** a9ace025c90c0da2161075da6ddd3492a2fca776
-
-Call the REST API to get the payment details by **including the access token in the request header** as follows:
-
-``` title="server-side"
-curl -H "Content-Type: application/json" -H "Authorization: Bearer a9ace025c90c0da2161075da6ddd3492a2fca776" https://api.iamport.kr/payments/imp_448280090638
-```
-
-
-
-
-```json title="server-side"
-axios({
- url: "https://api.iamport.kr/payments/imp_448280090638",
- method: "get", // GET method
- headers: {
- // "Content-Type": "application/json"
- "Content-Type": "application/json",
- // Reissuing and Reusing Access Token
-ssued access token
- "Authorization": "Bearer a9ace025c90c0da2161075da6ddd3492a2fca776"
- }
- });
-```
-
-
+
+ Call the REST API to get the payment details by **including the access token in the request header** as follows:
+
+ ```sh title="server-side"
+ curl -H "Content-Type: application/json" -H "Authorization: Bearer a9ace025c90c0da2161075da6ddd3492a2fca776" https://api.iamport.kr/payments/imp_448280090638
+ ```
+
+
+
+ ```ts title="server-side"
+ axios({
+ url: "https://api.iamport.kr/payments/imp_448280090638",
+ method: "get", // GET method
+ headers: {
+ // "Content-Type": "application/json"
+ "Content-Type": "application/json",
+ // Use issued access token
+ Authorization: "Bearer a9ace025c90c0da2161075da6ddd3492a2fca776",
+ },
+ });
+ ```
+
-### Reissuing and Reusing Access Token
+### Reissuing and Reusing Access Token
-The expiration of the access token is **30 minutes** from the time of issuance. A token **cannot be used after its expiration**. An API call request with an expired token returns a **`401 Unauthorized`** response.
+The expiration of the access token is **30 minutes** from the time of issuance.
+A token **cannot be used after its expiration**.
+An API call request with an expired token returns a **`401 Unauthorized`** response.
> - Reissuance (after expiration): A new access token is issued.
> (Expiration: 30 minutes after issuance)
@@ -156,14 +154,13 @@ The expiration of the access token is **30 minutes** from the time of issuance.
> - Reuse (before expiration): Existing access token is reused. (Expiration: same as before,
> but extended by 5 minutes if requested within 1 minute from the original expiration)
-![]()
+
-**5 minute extension of expiration**
-
-The reuse and 5 minute lifetime extension of access token are provided for the following situations:
+ **5 minute extension of expiration**
-- Multiple web servers of a single merchant are competing to call the REST API (`/users/getToken`) at the same time.
-- Multiple web servers of a single merchant are not synchronized in time.
+ The reuse and 5 minute lifetime extension of access token are provided for the following situations:
+ - Multiple web servers of a single merchant are competing to call the REST API (`/users/getToken`) at the same time.
+ - Multiple web servers of a single merchant are not synchronized in time.
diff --git a/src/content/docs/en/api/simple-payment-service-api/kakao-pay/get-order-api.mdx b/src/content/docs/en/api/simple-payment-service-api/kakao-pay/get-order-api.mdx
index 966526582..1d72c206b 100644
--- a/src/content/docs/en/api/simple-payment-service-api/kakao-pay/get-order-api.mdx
+++ b/src/content/docs/en/api/simple-payment-service-api/kakao-pay/get-order-api.mdx
@@ -3,66 +3,58 @@ title: Get order API
description: ''
---
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
+import Hint from "~/components/Hint.astro";
-### Gets order details (API that wraps [Kakao Pay's Get order details API](https://developers.kakao.com/docs/restapi/kakaopay-api#%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD%EC%A1%B0%ED%9A%8C)).
+## Gets order details (API that wraps [Kakao Pay's Get order details API](https://developers.kakao.com/docs/restapi/kakaopay-api#%EC%A3%BC%EB%AC%B8%EB%82%B4%EC%97%AD%EC%A1%B0%ED%9A%8C)).
-
-Request is similar and response is identical with Kakao Pay API.
-
-
-
-### Parameters
-
-#### Query
+
+ Request is similar and response is identical with Kakao Pay API.
+
-
-**Request date**
+ ### Parameters
-YYYYMMDD
+ #### Query
-
-
-**Kakao Pay MID**
+
+ **Request date**
-Default: Kakao Pay CID set in i'mport
+ YYYYMMDD
+
-
-
-**Page number**
+
+ **Kakao Pay MID**
-
+ Default: Kakao Pay CID set in i'mport
+
-
+
+ **Page number**
+
-### Responses
-
-
-```javascript
-{
- // Response
-}
-```
-
-
+ ### Responses
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
-**Swagger Test Link**
-
-[**https://api.iamport.kr/#!/kakao/getOrders**](https://api.iamport.kr/#!/kakao/getOrders)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/kakao/getOrders**](https://api.iamport.kr/#!/kakao/getOrders)
-### **Precaution**
-
-The support for this API will be terminated in**`2H of 2022`** due to Kakao Pay's policy change.
+ ### **Precaution**
+ The support for this API will be terminated in **`2H of 2022`** due to Kakao Pay's policy change.
diff --git a/src/content/docs/en/api/simple-payment-service-api/kcp-quick-pay/delete-user-api.mdx b/src/content/docs/en/api/simple-payment-service-api/kcp-quick-pay/delete-user-api.mdx
index e3c903a41..c6ac74312 100644
--- a/src/content/docs/en/api/simple-payment-service-api/kcp-quick-pay/delete-user-api.mdx
+++ b/src/content/docs/en/api/simple-payment-service-api/kcp-quick-pay/delete-user-api.mdx
@@ -4,142 +4,130 @@ description: ""
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Deletes a KCP Quick Pay user information.
+## Deletes a KCP Quick Pay user information.
-### Accept setting is required
+ ### Accept setting is required
-You must specify the Accept setting in the HTTP header as follows:
-
-**Accept : application/json**
+ You must specify the Accept setting in the HTTP header as follows:
+ **Accept : application/json**
-
-
-
-
-### Parameters
-
-#### Path
+
-
-**Member ID**
+ ### Parameters
-
-
-**KCP Quick Pay site code**
+ #### Path
-
-
-**KCP Quick Pay partner type**
+
+ **Member ID**
+
-
-
-**KCP Quick Pay partner subtype**
+
+ **KCP Quick Pay site code**
+
-
+
+ **KCP Quick Pay partner type**
+
-### Responses
+
+ **KCP Quick Pay partner subtype**
+
-
-
-
-**`code`** **\***** ****integer**
+ ### Responses
-**Response code**
+
+
+
+ **`code`** **\*** **integer**
-0: success, Not 0: check the message
+ **Response code**
-**`message`** **\***\*\* ****string\*\*
+ 0: success, Not 0: check the message
-**Response message**
+ **`message`** **\*** **string**
-A non-zero code includes a message like 'Invalid payment info'.
+ **Response message**
-**` response`` `****`(KcpQuickMemberAnnotation, optional)`**
+ A non-zero code includes a message like 'Invalid payment info'.
-
-
+ **`response`` `****`(KcpQuickMemberAnnotation, optional)`**
+
+
-
-
-**`member_id`****`*`****`string`**
+
+
+ **`member_id`****`*`****`string`**
-**`Member ID`**
+ **`Member ID`**
-**`pg_provider`****`*`****`string`**
+ **`pg_provider`****`*`****`string`**
-**`PG code`**
+ **`PG code`**
-**`pg_id`****`*`****`string`**
+ **`pg_id`****`*`****`string`**
-**`PG Merchant ID`**
+ **`PG Merchant ID`**
-**`inserted`****`*`****`integer`**
+ **`inserted`****`*`****`integer`**
-**`User created at (UNIX timestamp)`**
+ **`User created at (UNIX timestamp)`**
-**`updated`****`*`****`integer`**
+ **`updated`****`*`****`integer`**
-**`User updated at (UNIX timestamp)`**
+ **`User updated at (UNIX timestamp)`**
+
+
+
-
-
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
-
-
-```javascript
-{
- // Response
-}
-```
-
-
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
+
+ ```ts
+ {
+ // Response
+ }
+ ```
+
-
+
+ ```json
+ {
+ "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/#!/vbanks/modifyVbank**](https://api.iamport.kr/#!/vbanks/modifyVbank)
+ **Swagger Test Link**
+ [**https://api.iamport.kr/#!/vbanks/modifyVbank**](https://api.iamport.kr/#!/vbanks/modifyVbank)
diff --git a/src/content/docs/en/auth/guide-1/bill/pg-window.mdx b/src/content/docs/en/auth/guide-1/bill/pg-window.mdx
index 0fb4394de..37030cff3 100644
--- a/src/content/docs/en/auth/guide-1/bill/pg-window.mdx
+++ b/src/content/docs/en/auth/guide-1/bill/pg-window.mdx
@@ -4,154 +4,170 @@ description: Get a billing key through the payment window provided by the PG.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-#### You can enter the card information through the PG's payment window to get a billing key.
+You can enter the card information through the PG's payment window to get a billing key.
-- **Pros**: **no need to establish additional security process** for transmitting card information because the data is transmitted directly to PG without going through the server or i'mport server.
-- **Cons**: **cannot customize card registration form** since billing key is requested through the PG's payment window via web browser (cannot implement merchant site friendly UI/UX).
+- **Pros**: **no need to establish additional security process** for transmitting card information
+ because the data is transmitted directly to PG without going through the server or i'mport server.
-
+- **Cons**: **cannot customize card registration form** since billing key is requested
+ through the PG's payment window via web browser (cannot implement merchant site friendly UI/UX).
-### **STEP 01.** Request billing key
+
-As with authenticated payment, use the **JavaScript SDK** to call the PG's payment window. To get a billing key, specify the following additional parameters.
+## **STEP 01.** Request billing key
-> #### customer_uid: unique key that maps 1:1 with billing key
+As with authenticated payment, use the **JavaScript SDK** to call the PG's payment window.
+To get a billing key, specify the following additional parameters.
+
+> customer\_uid: unique key that maps 1:1 with billing key
-
-```javascript title="client-side"
- IMP.request_pay({ // Refer to above mentioned PG specific guide for param settings
- customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) {
- // Billing key request successful
- } else {
- // Billing key request failed
- }
- });
-```
-
-
-**What is a customer\_uid?**
-
-It is a unique value specified by the merchant that maps 1:1 with the billing key issued by PG. A unique `customer_uid` must be created for each card.
-
-Example: If a customer named **Hong Gildong** requests for a billing key from **A card**, the customer_uid must be issued for the **specified member's credit card number**
+
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ // Refer to above mentioned PG specific guide for param settings
+ customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // Billing key request successful
+ } else {
+ // Billing key request failed
+ }
+ },
+ );
+ ```
-
+
+ **What is a customer\_uid?**
-
+ It is a unique value specified by the merchant that maps 1:1 with the billing key issued by PG. A unique `customer_uid` must be created for each card.
+
+ Example: If a customer named **Hong Gildong** requests for a billing key from **A card**, the customer\_uid must be issued for the **specified member's credit card number**
+
+
### **STEP 02.** Handle response
-
-```javascript title="client-side"
- IMP.request_pay({ // param
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) {
- // Billing key request successful
- // jQuery HTTP request
- jQuery.ajax({
- url: "{URL to receive customer-uid}", // Example: https://www.myservice.com/billings/
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: {
- customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
+
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ // param
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // Billing key request successful
+ // jQuery HTTP request
+ jQuery.ajax({
+ url: "{URL to receive customer-uid}", // Example: https://www.myservice.com/billings/
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: {
+ customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
+ },
+ });
+ } else {
+ // Billing key request failed
}
- });
- } else {
- // Billing key request failed
- }
- });
-```
-
-Once the billing key is issued successfully, the **customer_uid** is sent to the merchant server. The server creates an API endpoint that receives the **customer_uid** from the client. The server can use the **customer_uid** to request future payments.\
-
-```javascript title="server-side"
- app.post("/billings", async (req, res) => {
- try {
- const { customer_uid } = req.body; // Get customer_uid from req.body
-
- ...
- } catch (e) {
- res.status(400).send(e);
- }
- });
-```
-
-Save the `customer_uid` in the merchant's database and use it to request future payments.
-
-
+ },
+ );
+ ```
+
+ Once the billing key is issued successfully, the **customer\_uid** is sent to the merchant server. The server creates an API endpoint that receives the **customer\_uid** from the client. The server can use the **customer\_uid** to request future payments.\\
+
+ ```ts title="server-side"
+ app.post("/billings", async (req, res) => {
+ try {
+ const { customer_uid } = req.body; // Get customer_uid from req.body
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
+ ```
+
+ Save the `customer_uid` in the merchant's database and use it to request future payments.
+
### **STEP 03.** Request payment
-Use the saved **customer_uid** and call the i'mport [**Non-authenticated payment (billing key) API**](../../../api/api/api) to request payment.
+Use the saved **customer\_uid** and call the i'mport
+[**Non-authenticated payment (billing key) API**](../../../api/api/api) to request payment.
-**To use the i'mport REST API, you must first get an** [**access token**](../../../api/rest-api-access-token).
-
+ **To use the i'mport REST API, you must first get an** [**access token**](../../../api/rest-api-access-token).
-
-```javascript title="server-side"
-app.post("/billings", async (req, res) => {
- try {
- const { customer_uid } = req.body; // Get customer_uid from req.body
- // Get billing key
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
- data: {
- imp_key: "imp_apikey", // REST API key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
+
+ ```ts title="server-side"
+ app.post("/billings", async (req, res) => {
+ try {
+ const { customer_uid } = req.body; // Get customer_uid from req.body
+ // Get billing key
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
+ data: {
+ imp_key: "imp_apikey", // REST API key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // Access token
+ // Request payment (for first or nth time)
+ const paymentResult = await axios({
+ url: `https://api.iamport.kr/subscribe/payments/again`,
+ method: "post",
+ headers: { Authorization: access_token }, // Add access token to authorization header
+ data: {
+ customer_uid,
+ merchant_uid: "order_monthly_0001", // Order ID
+ amount: 8900,
+ name: "recurring payments for monthly subscription",
+ },
+ });
+ const { code, message } = paymentResult;
+ if (code === 0) {
+ // Successful communication with the card company (additional check is required to confirm whether the payment was successful)
+ if (paymentResult.status === "paid") {
+ // Payment approved
+ res.send({
+ // ...
+ });
+ } else {
+ // Payment not approved (Example: card limit exceeded, card suspended, insufficient balance)
+ // paymentResult.status: failed is returned
+ res.send({
+ // ...
+ });
+ }
+ res.send({
+ // ...
+ });
+ } else {
+ // Card company rejected payment (paymentResult is null)
+ res.send({
+ // ...
+ });
}
- });
- const { access_token } = getToken.data.response; // Access token
- ...
- // Request payment (for first or nth time)
- const paymentResult = await axios({
- url: \`https://api.iamport.kr/subscribe/payments/again\`,
- method: "post",
- headers: { "Authorization": access_token }, // Add access token to authorization header
- data: {
- customer_uid,
- merchant_uid: "order_monthly_0001", // Order ID
- amount: 8900,
- name: "recurring payments for monthly subscription"
- }
- });
- ...
- const { code, message } = paymentResult;
- if (code === 0) { // Successful communication with the card company (additional check is required to confirm whether the payment was successful)
- if ( paymentResult.status === "paid" ) { // Payment approved
- res.send({ ... });
- } else { // Payment not approved (Example: card limit exceeded, card suspended, insufficient balance)
- // paymentResult.status: failed is returned
- res.send({ ... });
- }
- res.send({ ... });
- } else { // Card company rejected payment (paymentResult is null)
- res.send({ ... });
+ } catch (e) {
+ res.status(400).send(e);
}
- } catch (e) {
- res.status(400).send(e);
- }
- });
-```
-
-
+ });
+ ```
+
diff --git a/src/content/docs/en/auth/guide-1/bill/readme.mdx b/src/content/docs/en/auth/guide-1/bill/readme.mdx
index e8c2711ca..a09efa01d 100644
--- a/src/content/docs/en/auth/guide-1/bill/readme.mdx
+++ b/src/content/docs/en/auth/guide-1/bill/readme.mdx
@@ -3,59 +3,56 @@ title: Request billing key payment
description: Request a non-authenticated payment request with the credit card information.
---
+import Figure from "~/components/Figure.astro";
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Non-authenticated payment using a billing key
-**What is a billing key?**
-
-A billing key is an encryption key that can be used to make a payment at a desired time, such as subscriptions and Pay-As-You-Go payments. Since a merchant cannot store the customer's card information, it can get the card's billing key from the card company, store and use it to make payments.
+ **What is a billing key?**
+ A billing key is an encryption key that can be used to make a payment at a desired time, such as subscriptions and Pay-As-You-Go payments. Since a merchant cannot store the customer's card information, it can get the card's billing key from the card company, store and use it to make payments.
Depending on the PG, the billing key can be issued using the following two methods:
-
-#### Use i'mport REST API to get a billing key and use it to make a payment request.
-
-- `NICE Payments`
-- `JTNet`
-- `KCP`
-- `SettleBank`
-- `INICIS`
-- `DaouData`
-- `Paymentwall`
-
-
-
-
-#### Use a PG payment window to get a billing key.
-
-- `JTNet`
-- `INICIS`
-- `Danal (credit card, mobile)`
-- `Mobilians`
-- `Payco`
-- `KICC`
-- `KCP`
-- `Kakao Pay`
-- `Naver Pay`
-
-
+
+ Use i'mport REST API to get a billing key and use it to make a payment request.
+
+ - `NICE Payments`
+ - `JTNet`
+ - `KCP`
+ - `SettleBank`
+ - `INICIS`
+ - `DaouData`
+ - `Paymentwall`
+
+
+
+ Use a PG payment window to get a billing key.
+
+ - `JTNet`
+ - `INICIS`
+ - `Danal (credit card, mobile)`
+ - `Mobilians`
+ - `Payco`
+ - `KICC`
+ - `KCP`
+ - `Kakao Pay`
+ - `Naver Pay`
+
-## 2. Payment using card info (key-in payment)
+## 2. Payment using card info (key-in payment)
Upon pre-agreement with a PG, you can request a one-time payment using the credit card information.
This method requests payment by submitting card information each time. It is usually used by some
@@ -64,20 +61,18 @@ from customers via ARS to make a payment. Recently, as more merchants are using
method for authenticated payments, the use of key-in method is declining due to the inconvenience of
having to enter the card information every time.
-
+
-**An agreement with the PG is required to use key-in payment.**
-
+ **An agreement with the PG is required to use key-in payment.**
-
+ - NICE Payments
+ - NHN KCP
+ - JTNET
+ - SettleBank
+ - DaouData
diff --git a/src/content/docs/en/auth/guide-1/bill/rest-api.mdx b/src/content/docs/en/auth/guide-1/bill/rest-api.mdx
index 4bdf7fc64..88b27602b 100644
--- a/src/content/docs/en/auth/guide-1/bill/rest-api.mdx
+++ b/src/content/docs/en/auth/guide-1/bill/rest-api.mdx
@@ -4,9 +4,9 @@ description: Easily get a billing key using the i'mport REST API.
---
import Codepen from "~/components/gitbook/Codepen.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
You can use the i'mport REST API to request for a billing key to make a payment request. When you
request for a billing key with the customer's credit card information, the i'mport server calls the
@@ -19,137 +19,150 @@ has the following pros/cons:
requirements are strict for this service, and must take precautions to protect personal
information.
-#### If you are planning to develop a merchant UI/UX-friendly payment environment, API integration is the right choice.
+If you are planning to develop a merchant UI/UX-friendly payment environment,
+API integration is the right choice.
-### **STEP 01.** Accept credit card information
+## **STEP 01.** Accept credit card information
Add input fields for card information as shown below. Create a hidden field to store the
-**customer_uid** to send to the server upon form submission. For corporate cards (excluding cards
+**customer\_uid** to send to the server upon form submission. For corporate cards (excluding cards
issued under an employee's name), enter a _10-digit business registration number_ for the `birth`
parameter. The following example calls a `POST` request for `/subscription/issue-billing` with input
-values and **customer_uid** when you click the **Pay** button.
+values and **customer\_uid** when you click the **Pay** button.
-**What is a customer\_uid?**
+ **What is a customer\_uid?**
-It is a unique value specified by the merchant that maps 1:1 with the billing key issued by PG. A unique `customer_uid` must be created for each card.
-
-Example: If a customer named **Hong Gildong** requests for a billing key from **A card**, the customer_uid must be issued for the **specified member's credit card number**.
+ It is a unique value specified by the merchant that maps 1:1 with the billing key issued by PG. A unique `customer_uid` must be created for each card.
+ Example: If a customer named **Hong Gildong** requests for a billing key from **A card**, the customer\_uid must be issued for the **specified member's credit card number**.
-If you reuse the customer\_uid used to get the existing billing key, the existing billing key will be replaced with the new billing key issued on the new card number. (**The billing key that maps to the existing card will be deleted.**)
-
+ If you reuse the customer\_uid used to get the existing billing key, the existing billing key will be replaced with the new billing key issued on the new card number. (**The billing key that maps to the existing card will be deleted.**)
-**Credit card information required for billing key**
-
-- **Credit card number**
-- **Credit card expiration**
-- **DOB**
-- **First 2-digits of card password**
+ **Credit card information required for billing key**
+ - **Credit card number**
+ - **Credit card expiration**
+ - **DOB**
+ - **First 2-digits of card password**
-
-```html title="client-side"
-
-```
-
-
-
-
-```jsx title="client-side"
-// React.js
- class CardForm extends React.Components {
- constructor(props) {
- super(props);
- this.state = {
- cardNumber: "",
- expiry: "",
- birth: "",
- pwd2Digit: "",
- customer_uid: "gildong_0001_1234",
+
+ ```html title="client-side"
+
+ ```
+
+
+
+ ```tsx title="client-side"
+ // React.js
+ class CardForm extends React.Components {
+ constructor(props) {
+ super(props);
+ this.state = {
+ cardNumber: "",
+ expiry: "",
+ birth: "",
+ pwd2Digit: "",
+ customer_uid: "gildong_0001_1234",
+ };
+ }
+ handleInputChange = (event) => {
+ const { value, name } = event.target;
+ this.setState({
+ [name]: value,
+ });
};
+ handleFormSubmit = (event) => {
+ event.preventDefault();
+ const { cardNumber, expiry, birth, pwd2Digit, customer_uid } = this.state;
+ axios({
+ // Example: https://www.myservice.com/subscription/issue-billing
+ url: "{service URL to receive billing key request}",
+ method: "post",
+ data: {
+ cardNumber,
+ expiry,
+ birth,
+ pwd2Digit,
+ customer_uid,
+ },
+ }).then((rsp) => {
+ // Do something with the response
+ });
+ };
+ render() {
+ const { cardNumber, expiry, birth, pwd2Digit } = this.state;
+ return (
+
+ );
+ }
}
- ...
- handleInputChange = (event) => {
- const { value, name } = event.target;
- this.setState({
- [name]: value,
- });
- };
- ...
- handleFormSubmit = (event) => {
- event.preventDefault();
- const { cardNumber, expiry, birth, pwd2Digit, customer_uid } = this.state;
- axios({
- // Example: https://www.myservice.com/subscription/issue-billing
- url: "{service URL to receive billing key request}",
- method: "post",
- data: {
- cardNumber,
- expiry,
- birth,
- pwd2Digit,
- customer_uid,
- }
- }).then(rsp => {
- ...
- });
- };
- ...
- render() {
- const { cardNumber, expiry, birth, pwd2Digit } = this.state;
- return (
-
- )
- }
- }
-```
-
-
+ ```
+
@@ -157,29 +170,27 @@ If you reuse the customer\_uid used to get the existing billing key, the existin
### **STEP 02.** Extract card information
Create an API endpoint to extract the card information from the request body. The following is a
-sample **API endpoint** that processes a `POST` request to `/subscription/issue-billing`.\
+sample **API endpoint** that processes a `POST` request to `/subscription/issue-billing`.\\
-
-```javascript title="server-side"
-// Process POST request to "/subscription/issue-billing"
- app.post("/subscriptions/issue-billing", async (req, res) => {
- try {
- const {
- card_number, // card number
- expiry, // card expiration
- birth, // DOB
- pwd_2digit, // first 2-digits of card password
- customer_uid, // value that maps 1:1 with card (billing key)
- } = req.body; // extract card info from req.body
- ...
- } catch (e) {
- res.status(400).send(e);
- }
- });
-```
-
-
+
+ ```ts title="server-side"
+ // Process POST request to "/subscription/issue-billing"
+ app.post("/subscriptions/issue-billing", async (req, res) => {
+ try {
+ const {
+ card_number, // card number
+ expiry, // card expiration
+ birth, // DOB
+ pwd_2digit, // first 2-digits of card password
+ customer_uid, // value that maps 1:1 with card (billing key)
+ } = req.body; // extract card info from req.body
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
+ ```
+
### **STEP 03.** Request billing key and handle response
@@ -188,8 +199,8 @@ Request for a billing key by using the i'mport [**Get billing key REST API**](..
return a response based on the result code.
-
-```javascript title="server-side"
+
+ ```ts title="server-side"
// Process POST request to "/subscription/issue-billing"
app.post("/subscriptions/issue-billing", async (req, res) => {
try {
@@ -200,7 +211,6 @@ return a response based on the result code.
pwd_2digit, // First 2-digits of card password
customer_uid, // Unique ID for each card (billing key)
} = req.body; // Get card info from req.body
- ...
// Get billing key
const getToken = await axios({
url: "https://api.iamport.kr/users/getToken",
@@ -208,47 +218,48 @@ return a response based on the result code.
headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
data: {
imp_key: "imp_apikey", // REST API key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
});
const { access_token } = getToken.data.response; // Access token
- ...
// Get access token
const issueBilling = await axios({
- url: \`https://api.iamport.kr/subscribe/customers/\${customer_uid}\`,
+ url: `https://api.iamport.kr/subscribe/customers/${customer_uid}`,
method: "post",
- headers: { "Authorization": access_token }, // Add access token to authorization header
+ headers: { Authorization: access_token }, // Add access token to authorization header
data: {
card_number, // Card number
expiry, // Card expiration
birth, // Date of birth
pwd_2digit, // First 2-digits of card password
- }
+ },
});
- ...
const { code, message } = issueBilling.data;
- if (code === 0) { // Billing key request successful
- res.send({ status: "success", message: "Billing has successfully issued" });
- } else { // Billing key request failed
+ if (code === 0) {
+ // Billing key request successful
+ res.send({
+ status: "success",
+ message: "Billing has successfully issued",
+ });
+ } else {
+ // Billing key request failed
res.send({ status: "failed", message });
}
} catch (e) {
res.status(400).send(e);
}
});
-```
-
-
+ ```
+
-**To use the i'mport REST API, you must first get an** [**access token**](../../../api/rest-api-access-token)**.**
-
+ **To use the i'mport REST API, you must first get an** [**access token**](../../../api/rest-api-access-token)**.**
-**Request billing key and make payment at once**
-
-By using the key-in payment REST API[**`/subscribe/payments/onetime`**](../../../api/api/), you can get the billing key and make a payment in a single API call.
+ **Request billing key and make payment at once**
+ By using the key-in payment REST API[**`/subscribe/payments/onetime`**](../../../api/api/), you can get the billing key and make a payment in a single API call.
diff --git a/src/content/docs/en/auth/guide-1/page-1.mdx b/src/content/docs/en/auth/guide-1/page-1.mdx
index 46ee2b182..b8ffdc138 100644
--- a/src/content/docs/en/auth/guide-1/page-1.mdx
+++ b/src/content/docs/en/auth/guide-1/page-1.mdx
@@ -3,31 +3,35 @@ title: Key-in payment using card info
description: Request payments with only card information without authentication.
---
-import Details from "~/components/gitbook/Details.astro";
import Figure from "~/components/Figure.astro";
+import Details from "~/components/gitbook/Details.astro";
import Hint from "~/components/Hint.astro";
-Upon pre-agreement with a PG, you can request a one-time payment using the credit card information. This method requests payment by submitting card information each time. It is usually used by some merchants to avoid the hassle of authenticated payments or call centers that obtain card information from customers via ARS to make a payment. Recently, as more merchants are using a simple payment method for authenticated payments, the use of key-in method is declining due to the inconvenience of having to enter the card information every time.
+Upon pre-agreement with a PG, you can request a one-time payment using the credit card information.
+This method requests payment by submitting card information each time.
+It is usually used by some merchants to avoid the hassle of authenticated payments or call centers
+that obtain card information from customers via ARS to make a payment.
+Recently, as more merchants are using a simple payment method for authenticated payments,
+the use of key-in method is declining due to the inconvenience of having
+to enter the card information every time.
-
+
-**An agreement with the PG is required to use key-in payment.**
-
+ **An agreement with the PG is required to use key-in payment.**
-
+ - NICE Payments
+ - NHN KCP
+ - JTNET
+ - SettleBank
+ - DaouData
-You can request a key-in payment by using the [**Non-authenticated payment (one-time) API**](../../api/api/request-non-authenticated-payment-one-time-api) or the PG window.
+You can request a key-in payment by using
+the [**Non-authenticated payment (one-time) API**][one-time-api] or the PG window.
+
+[one-time-api]: ../../api/api/request-non-authenticated-payment-one-time-api
diff --git a/src/content/docs/en/auth/guide-1/subscription-payment-using-billing-key.mdx b/src/content/docs/en/auth/guide-1/subscription-payment-using-billing-key.mdx
index af270062a..dd19ef28e 100644
--- a/src/content/docs/en/auth/guide-1/subscription-payment-using-billing-key.mdx
+++ b/src/content/docs/en/auth/guide-1/subscription-payment-using-billing-key.mdx
@@ -7,37 +7,38 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Hint from "~/components/Hint.astro";
-#### subscriptionsubscriptionYou can use the customer\_uid obtained through the [Get billing key](../../api/billing-key-api/api-1) or [Non-authenticated payment (one-time)](../../api/api/request-non-authenticated-payment-one-time-api) API to request a subscription or scheduled payment.
+You can use the customer\_uid obtained through the [Get billing key](../../api/billing-key-api/api-1)
+or [Non-authenticated payment (one-time)](../../api/api/request-non-authenticated-payment-one-time-api) API
+to request a subscription or scheduled payment.
-### **STEP 01.** Request payment
+## **STEP 01.** Request payment
You can schedule a payment for a desired time in the future by using the ChaiPort **Schedule payment API**.
- ```javascript title="Node.js"
+ ```ts title="Node.js"
// Schedule payment
- axios({
- url: \`https://api.iamport.kr/subscribe/payments/schedule\`,
- method: "post",
- headers: { "Authorization": access_token }, // Add access token to authorization header
- data: {
- customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
- schedules: [
- {
- merchant_uid: "order_monthly_0001", // Order ID
- schedule_at: 1519862400, // Schedule time in UNIX timestamp.
- amount: 8900,
- name: "Recurring payment for monthly subscription",
- buyer_name: "Hong Gildong",
- buyer_tel: "01012345678",
- buyer_email: "gildong@gmail.com"
- }
- ]
- }
- });
-
- ```
+ axios({
+ url: `https://api.iamport.kr/subscribe/payments/schedule`,
+ method: "post",
+ headers: { Authorization: access_token }, // Add access token to authorization header
+ data: {
+ customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
+ schedules: [
+ {
+ merchant_uid: "order_monthly_0001", // Order ID
+ schedule_at: 1519862400, // Schedule time in UNIX timestamp.
+ amount: 8900,
+ name: "Recurring payment for monthly subscription",
+ buyer_name: "Hong Gildong",
+ buyer_tel: "01012345678",
+ buyer_email: "gildong@gmail.com",
+ },
+ ],
+ },
+ });
+```
@@ -56,41 +57,42 @@ result.
- ```javascript title="server-side"
+ ```ts title="server-side"
// Process POST request to "/iamport-callback/schedule"
- app.post("/iamport-callback/schedule", async (req, res) => {
- try {
- const { imp_uid, merchant_uid } = req.body;
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
- data: {
- imp_key: "imp_apikey", // REST API key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // Access token
- // Get payment info from i'mport server using imp_uid
- const getPaymentData = await axios({
- url: \`https://api.iamport.kr/payments/\${imp_uid}\`, // Pass imp_uid
- method: "get", // GET method
- headers: { "Authorization": access_token } // Add access token to authorization header
- });
- const paymentData = getPaymentData.data.response; // Save payment info
- const { status } = paymentData;
- if (status === "paid") { // If payment is successful
- // Save payment info in DB
- await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Mongoose
- ...
- } else {
- // Retry payment
- }
- } catch (e) {
- res.status(400).send(e);
- }
+ app.post("/iamport-callback/schedule", async (req, res) => {
+ try {
+ const { imp_uid, merchant_uid } = req.body;
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
+ data: {
+ imp_key: "imp_apikey", // REST API key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // Access token
+ // Get payment info from i'mport server using imp_uid
+ const getPaymentData = await axios({
+ url: `https://api.iamport.kr/payments/${imp_uid}`, // Pass imp_uid
+ method: "get", // GET method
+ headers: { Authorization: access_token }, // Add access token to authorization header
});
+ const paymentData = getPaymentData.data.response; // Save payment info
+ const { status } = paymentData;
+ if (status === "paid") {
+ // If payment is successful
+ // Save payment info in DB
+ await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Mongoose
+ } else {
+ // Retry payment
+ }
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
@@ -105,48 +107,49 @@ URL.
- ```javascript title="server-side"
- // Process POST request to "/iamport-callback/schedule"
- app.post("/iamport-callback/schedule", async (req, res) => {
- try {
- const { imp_uid, merchant_uid } = req.body;
- // Get access token
- /* ...Omitted ... */
- // Get payment info from i'mport server using imp_uid
- /* ...Omitted ... */
- const paymentData = getPaymentData.data.response; // Save payment info
- const { status } = paymentData;
- if (status === "paid") { // If payment is successful
- // Save payment info in DB
- await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Mongoose
- ...
- // Schedule next payment
- axios({
- url: "{URL to receive payment schedule}", // Example: https://api.iamport.kr/subscribe/payments/schedule
- method: "post",
- headers: { "Authorization": access_token }, // Add access token to authorization header
- data: {
- customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
- schedules: [
- {
- merchant_uid: "order_monthly_0001", // Order ID
- schedule_at: 1519516800, // Schedule time in UNIX timestamp.
- amount: 8900,
- name: "Recurring payment for monthly subscription",
- ...
- }
- ]
- }
- });
- } else {
- // Retry payment
- }
- } catch (e) {
- res.status(400).send(e);
- }
- });
+ ```ts title="server-side"
+ // Process POST request to "/iamport-callback/schedule"
+ app.post("/iamport-callback/schedule", async (req, res) => {
+ try {
+ const { imp_uid, merchant_uid } = req.body;
+ // Get access token
+ /* ...Omitted ... */
+ // Get payment info from i'mport server using imp_uid
+ /* ...Omitted ... */
+ const paymentData = getPaymentData.data.response; // Save payment info
+ const { status } = paymentData;
+ if (status === "paid") {
+ // If payment is successful
+ // Save payment info in DB
+ await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Mongoose
+ // Schedule next payment
+ axios({
+ url: "{URL to receive payment schedule}", // Example: https://api.iamport.kr/subscribe/payments/schedule
+ method: "post",
+ headers: { Authorization: access_token }, // Add access token to authorization header
+ data: {
+ customer_uid: "gildong_0001_1234", // Unique ID for each card (billing key)
+ schedules: [
+ {
+ merchant_uid: "order_monthly_0001", // Order ID
+ schedule_at: 1519516800, // Schedule time in UNIX timestamp.
+ amount: 8900,
+ name: "Recurring payment for monthly subscription",
+ },
+ ],
+ },
+ });
+ } else {
+ // Retry payment
+ }
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
- The above example processes the webhook event that occurs when a scheduled payment is attempted. If the scheduled payment is completed successfully, the payment information is saved in the database and the next payment is scheduled.
+ The above example processes the webhook event that occurs when a scheduled payment is attempted.
+ If the scheduled payment is completed successfully, the payment information is saved
+ in the database and the next payment is scheduled.
diff --git a/src/content/docs/en/auth/guide-2/readme.mdx b/src/content/docs/en/auth/guide-2/readme.mdx
index f77979dbf..22a98ceb1 100644
--- a/src/content/docs/en/auth/guide-2/readme.mdx
+++ b/src/content/docs/en/auth/guide-2/readme.mdx
@@ -4,134 +4,125 @@ description: Learn how to cancel a payment using the i'mport payment cancel API.
---
import Codepen from "~/components/gitbook/Codepen.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### **STEP 01.** Request cancellation
+## **STEP 01.** Request cancellation
Request a refund to the server with the required refund information. In the case of virtual account
refund, you need to specify additional parameters for the refund deposit account information. The
-following example requests a refund with the required refund information.\
+following example requests a refund with the required refund information.\\
-
-```html title="client-side"
-
-
-
-```
-
-
-
-
-
-
-```jsx title="client-side"
-class CancelPay extends React.Component {
- cancelPay = () => {
- axios({
- url: "{URL to receive refund request}", // Example: http://www.myservice.com/payments/cancel
- method: "POST",
- headers: {
- "Content-Type": "application/json,
- },
- data: {
- merchant_uid: "mid_" + new Date().getTime(), // Order ID
- cancel_request_amount: 2000, // Refund amount
- reason: "Refund for test payment" // Reason for the refund
- refund_holder: "Jone Doe", // [required for virtual account refund] refund account holder's name
- refund_bank: "88" // [required for virtual account refund] refund account bank code (e.g. Shinhan Bank is 88 for KG Inicis)
- refund_account: "56211105948400" // [required for virtual account refund] refund account number
+
+ ```html title="client-side"
+
+
+
+ ```
+
+
+
-
+
+ ```tsx title="client-side"
+ class CancelPay extends React.Component {
+ cancelPay = () => {
+ axios({
+ url: "{URL to receive refund request}", // Example: http://www.myservice.com/payments/cancel
+ method: "POST",
+ headers: {
+ "Content-Type": "application/json",
+ },
+ data: {
+ merchant_uid: "mid_" + new Date().getTime(), // Order ID
+ cancel_request_amount: 2000, // Refund amount
+ reason: "Refund for test payment", // Reason for the refund
+ refund_holder: "Jone Doe", // [required for virtual account refund] refund account holder's name
+ refund_bank: "88", // [required for virtual account refund] refund account bank code (e.g. Shinhan Bank is 88 for KG Inicis)
+ refund_account: "56211105948400", // [required for virtual account refund] refund account number
+ },
+ });
+ };
+ render() {
+ return ;
+ }
+ }
+ ```
+
### **STEP 02.** Get payment information
Assume that there is a **`Payments`** table that stores payment information as follows:
-```javascript title="server-side"
+```js title="server-side"
/* ... model/payments.js ... */
- var mongoose = require('mongoose');
- var Schema = mongoose.Schema;
- ...
- var PaymentsSchema = new Schema({
- imp_uid: String, // i'mport unique ID (unique key for refund)
- merchant_uid: String, // order ID (used to query payment information)
- amount: { type: Number, default: 0 }, // Payment amount (for calculating refundable amount)
- cancel_amount: { type: Number, default: 0 }, // Total amount refunded (for calculating refundable amount)
- ...
- });
- ...
- module.exports = mongoose.model('Payments', PaymentsSchema);
+const mongoose = require("mongoose");
+const Schema = mongoose.Schema;
+const PaymentsSchema = new Schema({
+ imp_uid: String, // i'mport unique ID (unique key for refund)
+ merchant_uid: String, // order ID (used to query payment information)
+ amount: { type: Number, default: 0 }, // Payment amount (for calculating refundable amount)
+ cancel_amount: { type: Number, default: 0 }, // Total amount refunded (for calculating refundable amount)
+});
+module.exports = mongoose.model("Payments", PaymentsSchema);
```
Query the payment information of the order from the **`Payments`** table using the order ID (**`merchant_uid`**) received from the client.
-```javascript title="server-side"
- /* ... Omitted ... */
- var Payments = require('./models/payments');
- app.post('/payments/cancel', async (req, res, next) => {
- try {
- /* Get access token */
- /* ... Omitted ... */
- /* Get payment information */
- const { body } = req;
- const { merchant_uid } = body; // Order ID from the client
- Payments.find({ merchant_uid }, async function(err, payment) {
- if (err) {
- return res.json(err);
- }
- const paymentData = payment[0]; // Save payment information
- /* Call i'mport REST API to request refund */
- ...
- });
- } catch (error) {
- res.status(400).send(error);
- }
- });
-
+```js title="server-side"
+/* ... Omitted ... */
+const Payments = require("./models/payments");
+app.post("/payments/cancel", async (req, res, next) => {
+ try {
+ /* Get access token */
+ /* ... Omitted ... */
+ /* Get payment information */
+ const { body } = req;
+ const { merchant_uid } = body; // Order ID from the client
+ Payments.find({ merchant_uid }, async function (err, payment) {
+ if (err) {
+ return res.json(err);
+ }
+ const paymentData = payment[0]; // Save payment information
+ /* Call i'mport REST API to request refund */
+ });
+ } catch (error) {
+ res.status(400).send(error);
+ }
+});
```
### **STEP 03.** Request refund to i'mport server
-To request a refund, you must first get a [**REST API access token**](../../api/rest-api-access-token). Use the **`access token`** to call the [**i'mport cancel ****API**](../../api/payment-api/cancel-payment-api) to request a refund.
+To request a refund, you must first get a [**REST API access token**](../../api/rest-api-access-token). Use the **`access token`** to call the [**i'mport cancel** **API**](../../api/payment-api/cancel-payment-api) to request a refund.
-**Note - Refunding mobile micropayments**
-
-- If a refund is **requested on a different month from when the payment is made, a full refund is not allowed**. For example, a payment made on January 31st is not refundable on February 1st.
+ **Note - Refunding mobile micropayments**
+ - If a refund is **requested on a different month from when the payment is made, a full refund is not allowed**. For example, a payment made on January 31st is not refundable on February 1st.
**Setting parameters for refund request:**
@@ -155,66 +146,66 @@ To request a refund, you must first get a [**REST API
> refund request will fail. If the `checksum` is not specified, the verification is not performed.
-**Reason for entering checksum**
+ **Reason for entering checksum**
-`checksum` is not required, but it is recommended for **comparing the refundable amount between the merchant server and the i'mport server**.
+ `checksum` is not required, but it is recommended for **comparing the refundable amount between the merchant server and the i'mport server**.
-For example, consider the case when a partial refund request of 1,000 won for a 10,000 won payment was completed on the i'mport server, but not on the merchant server due to a server or database error. In this case, the checksum of the i'mport server is changed to 9000, but that of the merchant server remains 10,000.
-
-If you attempt to make a refund request with `checksum(10000)`, the request will fail because the value does not match the `checksum(9000)` of the i'mport server.
+ For example, consider the case when a partial refund request of 1,000 won for a 10,000 won payment was completed on the i'mport server, but not on the merchant server due to a server or database error. In this case, the checksum of the i'mport server is changed to 9000, but that of the merchant server remains 10,000.
+ If you attempt to make a refund request with `checksum(10000)`, the request will fail because the value does not match the `checksum(9000)` of the i'mport server.
#### The following example requests a refund.
-```javascript title="Node.js"
- /* ... Omitted ... */
- app.post('/payments/cancel', async (req, res, next) => {
- try {
- /* Get access token */
+```ts title="Node.js"
+/* ... Omitted ... */
+app.post("/payments/cancel", async (req, res, next) => {
+ try {
+ /* Get access token */
+ /* ... Omitted ... */
+ /* Get payment information */
+ const { body } = req;
+ const { merchant_uid, reason, cancel_request_amount } = body; // Order ID from the client, reason for refund, refund amount
+ Payments.find({ merchant_uid }, async function (err, payment) {
/* ... Omitted ... */
- /* Get payment information */
- const { body } = req;
- const { merchant_uid, reason, cancel_request_amount } = body; // Order ID from the client, reason for refund, refund amount
- Payments.find({ merchant_uid }, async function(err, payment) {
- /* ... Omitted ... */
- const paymentData = payment[0]; // Save payment information
- const { imp_uid, amount, cancel_amount } = paymentData; // Get imp_uid, amount(paid amount), cancel_amount(total refund amount) from payment information
- const cancelableAmount = amount - cancel_amount; // Refundable amount (= paid amount - total refund amount)
- if (cancelableAmount <= 0) { // If refundable amount is 0
- return res.status(400).json({ message: "This order has already been fully refunded." });
- }
- ...
- /* Call i'mport REST API to request refund */
- const getCancelData = await axios({
- url: "{URL to receive refund request}", // Example: http://www.myservice.com/payments/cancel
- method: "post",
- headers: {
- "Content-Type": "application/json",
- "Authorization": access_token // Access token from i'mport server
- },
- data: {
- reason, // Reason for refund from client
- imp_uid, // Unique key for refund
- amount: cancel_request_amount, // Requested refund amount
- checksum: cancelableAmount // [Recommended] refundable amount
- }
- });
- const { response } = getCancelData.data; // Refund result
- /* Save refund result */
- ...
+ const paymentData = payment[0]; // Save payment information
+ const { imp_uid, amount, cancel_amount } = paymentData; // Get imp_uid, amount(paid amount), cancel_amount(total refund amount) from payment information
+ const cancelableAmount = amount - cancel_amount; // Refundable amount (= paid amount - total refund amount)
+ if (cancelableAmount <= 0) {
+ // If refundable amount is 0
+ return res
+ .status(400)
+ .json({ message: "This order has already been fully refunded." });
+ }
+ /* Call i'mport REST API to request refund */
+ const getCancelData = await axios({
+ url: "{URL to receive refund request}", // Example: http://www.myservice.com/payments/cancel
+ method: "post",
+ headers: {
+ "Content-Type": "application/json",
+ Authorization: access_token, // Access token from i'mport server
+ },
+ data: {
+ reason, // Reason for refund from client
+ imp_uid, // Unique key for refund
+ amount: cancel_request_amount, // Requested refund amount
+ checksum: cancelableAmount, // [Recommended] refundable amount
+ },
});
- } catch (error) {
- res.status(400).send(error);
- }
- });
+ const { response } = getCancelData.data; // Refund result
+ /* Save refund result */
+ });
+ } catch (error) {
+ res.status(400).send(error);
+ }
+});
```
### **STEP 04.** Save refund result
-#### After the refund process is completed, save the result in the database as follows:
+After the refund process is completed, save the result in the database as follows:
-```javascript title="Node.js"
+```ts title="Node.js"
/* ... Omitted ... */
app.post("/payments/cancel", async (req, res, next) => {
try {
@@ -238,7 +229,7 @@ app.post("/payments/cancel", async (req, res, next) => {
return res.json(err);
}
res.json(payment); // Return refund result to the client
- }
+ },
);
});
} catch (error) {
@@ -248,10 +239,9 @@ app.post("/payments/cancel", async (req, res, next) => {
```
-**Note - When cancelling a payment**
-
-Even if a **response code of 200 (OK)** is returned for the REST API ([**POST https://api.iamport.kr/payments/cancel**](https://api.iamport.kr/#!/payments/cancelPayment)) request, a non-zero code in the response body **means that the refund has failed**. You can check the reason for the failure in the message of the body.
+ **Note - When cancelling a payment**
+ Even if a **response code of 200 (OK)** is returned for the REST API ([**POST https://api.iamport.kr/payments/cancel**](https://api.iamport.kr/#!/payments/cancelPayment)) request, a non-zero code in the response body **means that the refund has failed**. You can check the reason for the failure in the message of the body.
### **STEP 04.** Handle response for refund request
@@ -259,46 +249,47 @@ Even if a **response code of 200 (OK)** is returned for the REST API ([**POST ht
Add the client-side logic to handle the response from the server as follows:
-
-```html title="client-side"
-
-
-
-```
-
-
-
-
-```jsx title="client-side"
-class CancelPay extends React.Component {
- cancelPay = () => {
- axios({
- /* ... Omitted ... */
- }).then(response => { // If refund is successful
- alert("Refund successful");
- }).catch(error => { // If refund fails
- alert("Refund failed");
- });
- }
- ...
- render() {
- return ;
- }
-}
-```
-
-
+
+ ```html title="client-side"
+
+
+
+ ```
+
+
+
+ ```tsx title="client-side"
+ class CancelPay extends React.Component {
+ cancelPay = () => {
+ axios({
+ /* ... Omitted ... */
+ })
+ .then((response) => {
+ // If refund is successful
+ alert("Refund successful");
+ })
+ .catch((error) => {
+ // If refund fails
+ alert("Refund failed");
+ });
+ };
+ render() {
+ return ;
+ }
+ }
+ ```
+
diff --git a/src/content/docs/en/auth/guide-2/refund.mdx b/src/content/docs/en/auth/guide-2/refund.mdx
index 871f8d3bd..6ace37b4a 100644
--- a/src/content/docs/en/auth/guide-2/refund.mdx
+++ b/src/content/docs/en/auth/guide-2/refund.mdx
@@ -6,84 +6,91 @@ description: Request a refund for a virtual account payment.
import Figure from "~/components/Figure.astro";
import Hint from "~/components/Hint.astro";
-### For a virtual account refund, you must sign up for the v**irtual account special service** provided by each PG.
+For a virtual account refund, you must sign up for the **virtual account special service**
+provided by each PG.
-**Why do you need to sign up for a virtual account special service?**
+ **Why do you need to sign up for a virtual account special service?**
-Unlike credit cards, fees for payment/refund are not subject to refund for virtual account refund. For example, for a 10,000 won payment, the merchant:
+ Unlike credit cards, fees for payment/refund are not subject to refund for virtual account refund. For example, for a 10,000 won payment, the merchant:
-- receives 9700 won (10,000 won - virtual account issuance fee of 300 won) from the PG at the time of payment.
-- pays 10,300 won (10,000 won to be refunded + 300 won remittance fee for the refund account) to the PG company when the payment is refunded.
-
-To prevent confusion that may arise regarding fees for virtual account refund, PGs provide **virtual account refunds only to merchants who are signed up for the virtual account special service**.
+ - receives 9700 won (10,000 won - virtual account issuance fee of 300 won) from the PG at the time of payment.
+ - pays 10,300 won (10,000 won to be refunded + 300 won remittance fee for the refund account) to the PG company when the payment is refunded.
+ To prevent confusion that may arise regarding fees for virtual account refund, PGs provide **virtual account refunds only to merchants who are signed up for the virtual account special service**.
-Since a virtual account transaction involves a one-way payment method, the target account for refund is unknown. Hence, you must specify the following refund account information in addition to the refund amount.
+Since a virtual account transaction involves a one-way payment method,
+the target account for refund is unknown.
+Hence, you must specify the following refund account information in addition to the refund amount.
- `refund_holder`: Refund account holder's name
- `refund_account`: Refund account number
- `refund_bank`: Refund account bank code
-**Note - Virtual account bank codes by PG**
-
-Since the **virtual account bank code** varies by PG even for the same bank, be sure to check the [**Bank codes by PG**](../../tips/bank-codes-by-pg) list.
+ **Note - Virtual account bank codes by PG**
+ Since the **virtual account bank code** varies by PG even for the same bank, be sure to check the [**Bank codes by PG**](../../tips/bank-codes-by-pg) list.
-#### The following example requests for a virtual account refund.
-
-```javascript title="Node.js"
- /* ... Omitted ... */
- app.post('/payments/cancel', async (req, res, next) => {
- try {
- /* Get access token */
+The following example requests for a virtual account refund.
+
+```ts title="Node.js"
+/* ... Omitted ... */
+app.post("/payments/cancel", async (req, res, next) => {
+ try {
+ /* Get access token */
+ /* ... Omitted ... */
+ /* Get payment information */
+ const { body } = req;
+ const {
+ merchant_uid,
+ reason,
+ cancel_request_amount,
+ refund_holder,
+ refund_bank,
+ refund_account,
+ } = body; // Order ID from the client, reason for refund, refund amount, virtual accoun info (account holder, account number, bank code
+ Payments.find({ merchant_uid }, async function (err, payment) {
/* ... Omitted ... */
- /* Get payment information */
- const { body } = req;
- const { merchant_uid, reason, cancel_request_amount, refund_holder, refund_bank, refund_account } = body; // Order ID from the client, reason for refund, refund amount, virtual accoun info (account holder, account number, bank code
- Payments.find({ merchant_uid }, async function(err, payment) {
- /* ... Omitted ... */
- const paymentData = payment[0]; // Save payment information
- const { imp_uid, amount, cancel_amount } = paymentData; // Get imp_uid, amount(paid amount), cancel_amount(total refund amount) from payment information
- const cancelableAmount = amount - cancel_amount; // Refundable amount (= paid amount - total refund amount)
- if (cancelableAmount <= 0) { // If refundable amount is 0
- return res.status(400).json({ message: "This order has already been fully refunded." });
- }
- ...
- /* Call i'mport REST API to request refund */
- const getCancelData = await axios({
- url: "https://api.iamport.kr/payments/cancel",
- method: "post",
- headers: {
- "Content-Type": "application/json",
- "Authorization": access_token // Access token from i'mport server
- },
- data: {
- reason, // Reason for refund from client
- imp_uid, // Unique key for refund
- amount: cancel_request_amount, // Requested refund amount
- checksum: cancelableAmount, // [Recommended] refundable amount
- refund_holder, // [required when refunding virtual account payment] refund account holder's name
- refund_bank, // [required for virtual account refund] refund account bank code (e.g. Shinhan Bank is 88 for KG Inicis)
- refund_account // [required for virtual account refund] refund account number
- }
- });
- const { response } = getCancelData.data; // Refund result
- /* Save refund result */
- ...
+ const paymentData = payment[0]; // Save payment information
+ const { imp_uid, amount, cancel_amount } = paymentData; // Get imp_uid, amount(paid amount), cancel_amount(total refund amount) from payment information
+ const cancelableAmount = amount - cancel_amount; // Refundable amount (= paid amount - total refund amount)
+ if (cancelableAmount <= 0) {
+ // If refundable amount is 0
+ return res
+ .status(400)
+ .json({ message: "This order has already been fully refunded." });
+ }
+ /* Call i'mport REST API to request refund */
+ const getCancelData = await axios({
+ url: "https://api.iamport.kr/payments/cancel",
+ method: "post",
+ headers: {
+ "Content-Type": "application/json",
+ Authorization: access_token, // Access token from i'mport server
+ },
+ data: {
+ reason, // Reason for refund from client
+ imp_uid, // Unique key for refund
+ amount: cancel_request_amount, // Requested refund amount
+ checksum: cancelableAmount, // [Recommended] refundable amount
+ refund_holder, // [required when refunding virtual account payment] refund account holder's name
+ refund_bank, // [required for virtual account refund] refund account bank code (e.g. Shinhan Bank is 88 for KG Inicis)
+ refund_account, // [required for virtual account refund] refund account number
+ },
});
- } catch (error) {
- res.status(400).send(error);
- }
- });
+ const { response } = getCancelData.data; // Refund result
+ /* Save refund result */
+ });
+ } catch (error) {
+ res.status(400).send(error);
+ }
+});
```
-If the virtual account refund request is successful, the refund amount will be deposited (from PG) into the specified refund account normally in about one working day.
+If the virtual account refund request is successful, the refund amount will be deposited (from PG)
+into the specified refund account normally in about one working day.
-
+
diff --git a/src/content/docs/en/auth/guide/1.mdx b/src/content/docs/en/auth/guide/1.mdx
index 5273dd300..e447baf7e 100644
--- a/src/content/docs/en/auth/guide/1.mdx
+++ b/src/content/docs/en/auth/guide/1.mdx
@@ -8,7 +8,7 @@ description: >-
import Youtube from "~/components/gitbook/Youtube.astro";
import Hint from "~/components/Hint.astro";
-#### Add the following JS library to the client-side page for payment integration.
+Add the following JS library to the client-side page for payment integration.
You must first install **jQuery 1.0 or later version**.
diff --git a/src/content/docs/en/auth/guide/2.mdx b/src/content/docs/en/auth/guide/2.mdx
index 8fa2ce4f2..c01c5da6e 100644
--- a/src/content/docs/en/auth/guide/2.mdx
+++ b/src/content/docs/en/auth/guide/2.mdx
@@ -7,20 +7,20 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Hint from "~/components/Hint.astro";
-#### On the checkout page, initialize the IMP object using your [Merchant ID](../../ready/3.).
+On the checkout page, initialize the IMP object using your [Merchant ID](../../ready/3.).
- ```javascript title="Client-side"
- var IMP = window.IMP; // Can be omitted
- IMP.init("Merchant ID"); // Example: imp00000000
+ ```ts title="Client-side"
+ const IMP = window.IMP; // Can be omitted
+ IMP.init("Merchant ID"); // Example: imp00000000
```
- ```javascript title="Client-side"
- const IMP = window.IMP; // Can be omitted
- IMP.init("{Merchant ID}"); // Example: imp00000000a
+ ```ts title="Client-side"
+ const IMP = window.IMP; // Can be omitted
+ IMP.init("{Merchant ID}"); // Example: imp00000000a
```
diff --git a/src/content/docs/en/auth/guide/3.mdx b/src/content/docs/en/auth/guide/3.mdx
index cf06e1972..aa2d46999 100644
--- a/src/content/docs/en/auth/guide/3.mdx
+++ b/src/content/docs/en/auth/guide/3.mdx
@@ -16,41 +16,39 @@ the first argument of the **request\_pay** function.
- ```javascript
-
+ },
+ );
```
- ```jsx
- class RequestPay extends React.Component {
- requestPay = () => {
- IMP.request_pay({ // param
+ ```tsx
+ export class RequestPay extends React.Component {
+ requestPay = () => {
+ IMP.request_pay(
+ {
+ // param
pg: "kcp",
pay_method: "card",
merchant_uid: "ORD20180131-0000011",
@@ -60,54 +58,53 @@ the first argument of the **request\_pay** function.
buyer_name: "Hong Gildong",
buyer_tel: "010-4242-4242",
buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "01181"
- }, rsp => { // callback
+ buyer_postcode: "01181",
+ },
+ (rsp) => {
+ // callback
if (rsp.success) {
- ...,
// Payment is successful
- ...
} else {
- ...,
// Payment failed
- ...
}
- });
- }
+ },
+ );
+ };
+ }
```
- ```javascript
-
+ ```ts
+ export default {
+ methods: {
+ requestPay: function () {
+ IMP.request_pay(
+ {
+ // param
+ pg: "kcp",
+ pay_method: "card",
+ merchant_uid: "ORD20180131-0000011",
+ name: "Norway swivel chair",
+ amount: 64900,
+ buyer_email: "gildong@gmail.com",
+ buyer_name: "Hong Gildong",
+ buyer_tel: "010-4242-4242",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "01181",
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // Payment is successful
+ } else {
+ // Payment failed
+ }
+ },
+ );
+ },
+ },
+ };
```
@@ -115,11 +112,11 @@ the first argument of the **request\_pay** function.
**Note - Creating an order ID (merchant\_uid)**
- - The order number must always be assigned a **unique** **value** when the payment window is requested.
+ - The order number must always be assigned a **unique value** when the payment window is requested.
- After the payment process is complete, the server uses the order ID to retrieve the order information for **payment fraud check**. Be sure to create a **unique ID** on the merchant server and **store it in the DB**.
-#### The following is the above sample code with the Pay button added.
+The following is the above sample code with the Pay button added.
```html title="sample.html"
diff --git a/src/content/docs/en/auth/guide/4/iframe.mdx b/src/content/docs/en/auth/guide/4/iframe.mdx
index caa36d444..dac52015e 100644
--- a/src/content/docs/en/auth/guide/4/iframe.mdx
+++ b/src/content/docs/en/auth/guide/4/iframe.mdx
@@ -15,7 +15,8 @@ import Hint from "~/components/Hint.astro";
-#### Most payments that are processed in the PC environment can receive payment results through the callback function, which is the second argument of the request\_pay() function.
+Most payments that are processed in the PC environment can receive payment results
+through the callback function, which is the second argument of the request\_pay() function.
For **PayPal** payments, the payment window is loaded as a **pop-up (new window)** in a PC environment and you can also receive the payment result through **m\_redirect\_url**.
@@ -26,36 +27,47 @@ import Hint from "~/components/Hint.astro";
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
- // HTTP request with jQuery
- jQuery.ajax({
- url: "{Merchant endpoint that receives server's payment info}",
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: {
- imp_uid: rsp.imp_uid, // Payment ID
- merchant_uid: rsp.merchant_uid // Order ID
- }
- }).done(function (data) {
- // Merchant server payment API call is successful
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
+ // HTTP request with jQuery
+ jQuery
+ .ajax({
+ url: "{Merchant endpoint that receives server's payment info}",
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: {
+ imp_uid: rsp.imp_uid, // Payment ID
+ merchant_uid: rsp.merchant_uid, // Order ID
+ },
})
- } else {
- alert("Payment failed. Error: " + rsp.error_msg);
- }
- });
+ .done(function (data) {
+ // Merchant server payment API call is successful
+ console.log(data);
+ });
+ } else {
+ alert("Payment failed. Error: " + rsp.error_msg);
+ }
+ },
+ );
```
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) {
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
// HTTP request with axios
axios({
url: "{Endpoint that receives server's payment info}",
@@ -63,15 +75,17 @@ import Hint from "~/components/Hint.astro";
headers: { "Content-Type": "application/json" },
data: {
imp_uid: rsp.imp_uid,
- merchant_uid: rsp.merchant_uid
- }
+ merchant_uid: rsp.merchant_uid,
+ },
}).then((data) => {
// Server payment API call is successful
- })
+ console.log(data);
+ });
} else {
- alert(\`Payment failed. Error: \${rsp.error_msg}\`);
+ alert(`Payment failed. Error: ${rsp.error_msg}`);
}
- });
+ },
+ );
```
@@ -85,5 +99,6 @@ above.
> For information about the response parameter passed to the **callback** function, refer to [**rsp**](../../../sdk/javascript-sdk/undefined-1).
- The final payment result logic processing must be handled stably by using a [**webhook**](../../../result/webhook). If you don't set up a webhook, you may fail to receive the payment result.
+ The final payment result logic processing must be handled stably by using a [**webhook**](../../../result/webhook).
+ If you don't set up a webhook, you may fail to receive the payment result.
diff --git a/src/content/docs/en/auth/guide/4/redirect.mdx b/src/content/docs/en/auth/guide/4/redirect.mdx
index 822f9876a..4e4d4c695 100644
--- a/src/content/docs/en/auth/guide/4/redirect.mdx
+++ b/src/content/docs/en/auth/guide/4/redirect.mdx
@@ -9,7 +9,6 @@ import ContentRef from "~/components/gitbook/ContentRef.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
-import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Hint from "~/components/Hint.astro";
@@ -22,25 +21,30 @@ import Hint from "~/components/Hint.astro";
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */,
- m_redirect_url: "{redirect URL}"
- }, /* callback */); // callback is not called
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ m_redirect_url: "{redirect URL}",
+ } /* callback */,
+ ); // callback is not called
```
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */,
- m_redirect_url: "{redirect URL}"
- }, /* callback */); // callback is not called
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ m_redirect_url: "{redirect URL}",
+ } /* callback */,
+ ); // callback is not called
```
-If **m\_redirect\_url** is specified as the **request\_pay** function parameter as above, the payment result is sent to the URL address in the form of a query string after **payment is completed**.
+If **m\_redirect\_url** is specified as the **request\_pay** function parameter as above,
+the payment result is sent to the URL address in the form of a query string after **payment is completed**.
**What is a query string?**
@@ -53,9 +57,9 @@ If **m\_redirect\_url** is specified as the **request\_pay** function parameter
You can receive the following parameters through the specified URL as a query string.
- ### Parameters
+ ## Parameters
- #### Query
+ ### Query
i'mport payment ID
@@ -80,13 +84,13 @@ The following is an example of a redirecting URL based on the query string.
- ```url
+ ```sh
curl https://myservice.com/payments/complete?imp_uid=unique_iamport_paymentID&merchant_uid=unique_merchant_orderID&imp_success=true
```
- ```
+ ```sh
curl https://myservice.com/payments/complete?imp_uid=unique_iamport_paymentID&merchant_uid=unique_merchant_orderID&imp_success=false&error_code=error_code(none_defined_currently)&error_msg=error_message
```
@@ -105,16 +109,26 @@ The following is an example of a redirecting URL based on the query string.
> The `payment process is complete` when:
>
> 1. **Payment is successful** (Status: `paid`, imp\_success: `true`)
+>
> 2. **Payment fails** (Status: `failed`, imp\_success: `false`)
+>
> 3. **Payment window fails to open** due to PG module setting error
+>
> 4. User **terminates the payment process** by clicking the X or Cancel button
-> 5. **Payment is suspended** due to invalid card information, limit exceeded, insufficient balance, etc.
+>
+> 5. **Payment is suspended** due to invalid card information,
+> limit exceeded, insufficient balance, etc.
+>
> 6. **Virtual account is issued** (status: `ready`, imp\_success: `true`)
**Note - imp\_success parameter**
- The `imp_success` parameter indicates **whether or not the payment process completed successfully**. However, since the payment page is opened by calling a JavaScript function from the client-side, **the payment amount can be forged** by a malicious user. Hence, **this value should not be used to determine the success of the payment**. Depending on the value of `imp_success`, determine the payment success as follows:
+ The `imp_success` parameter indicates **whether or not the payment process completed successfully**.
+ However, since the payment page is opened by calling a JavaScript function from the client-side,
+ **the payment amount can be forged** by a malicious user.
+ Hence, **this value should not be used to determine the success of the payment**.
+ Depending on the value of `imp_success`, determine the payment success as follows:
- imp\_success = true: First send payment information (imp\_uid, merchant\_uid) to the server to verify the payment amount, and then finalize payment success.
- imp\_success = false: Alert the user that the payment failed.
diff --git a/src/content/docs/en/auth/guide/5.mdx b/src/content/docs/en/auth/guide/5.mdx
index 7489452cb..d12d952e8 100644
--- a/src/content/docs/en/auth/guide/5.mdx
+++ b/src/content/docs/en/auth/guide/5.mdx
@@ -10,24 +10,27 @@ import Hint from "~/components/Hint.astro";
Based on the payment information from the client, the server verifies the **payment amount for fraud** and saves the payment information in the database if needed. The following are the steps for verifying the payment information.
- Server receives the i'mport payment ID (**imp\_uid**) and order ID (**merchant\_uid**)
+
- Call the [**Get payment API**](https://api.iamport.kr/#!/payments/getPaymentByImpUid) to get the
payment details.
+
- Based on the response, compare the actual payment amount with the payment request amount (from
merchant's database).
-### **STEP 01** Server receives payment result
+## **STEP 01** Server receives payment result
Example of receiving a POST request to the merchant endpoint URL that receives the payment information
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
// "{Merchant endpoint that receives server's payment info}" POST request receiver
app.post("/payments/complete", async (req, res) => {
try {
// Get imp_uid, merchant_uid from req.body
const { imp_uid, merchant_uid } = req.body;
+ console.log(imp_uid, merchant_uid);
} catch (e) {
res.status(400).send(e);
}
@@ -42,41 +45,40 @@ Based on the payment information from the client, the server verifies the
Example of calling the [**Get payment**](https://api.iamport.kr/#!/payments/getPaymentByImpUid) **API** with the i'mport **payment ID (imp\_uid)** to retrieve the payment info.
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
- ...
- app.post("/payments/complete", async (req, res) => {
- try {
- // Get imp_uid, merchant_uid from req.body
- const { imp_uid, merchant_uid } = req.body;
- ...
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" },
- data: {
- imp_key: "imp_apikey", // REST API key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // access token
- ...
- // Get payment info from i'mport server using imp_uid
- const getPaymentData = await axios({
- // Pass imp_uid
- url: \`https://api.iamport.kr/payments/\${imp_uid}\`,
- // GET method
- method: "get",
- // Add access toke to Authorization header
- headers: { "Authorization": access_token }
- });
- const paymentData = getPaymentData.data.response; // Payment info
- ...
- } catch (e) {
- res.status(400).send(e);
- }
+ app.post("/payments/complete", async (req, res) => {
+ try {
+ // Get imp_uid, merchant_uid from req.body
+ const { imp_uid, merchant_uid } = req.body;
+ console.log(imp_uid, merchant_uid);
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" },
+ data: {
+ imp_key: "imp_apikey", // REST API key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // access token
+ // Get payment info from i'mport server using imp_uid
+ const getPaymentData = await axios({
+ // Pass imp_uid
+ url: `https://api.iamport.kr/payments/${imp_uid}`,
+ // GET method
+ method: "get",
+ // Add access toke to Authorization header
+ headers: { Authorization: access_token },
});
+ const paymentData = getPaymentData.data.response; // Payment info
+ console.log(paymentData);
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
@@ -99,49 +101,60 @@ Based on the payment information from the client, the server verifies the
Example of comparing the actual payment amount with the payment request amount, performing fraud check on the payment amount, and saving the data in the DB.
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
- ...
- app.post("/payments/complete", async (req, res) => {
- try {
- // Get imp_uid, merchant_uid from req.body
- const { imp_uid, merchant_uid } = req.body;
- // Get access token
- /* ...Omitted... */
- // Get payment info from iamport server using imp_uid
- /* ...Omitted... */
- const paymentData = getPaymentData.data.response; // Payment info
- ...
- // Get the requested payment amount from the DB
- const order = await Orders.findById(paymentData.merchant_uid);
- const amountToBePaid = order.amount; // Requested payment amount
- ...
- // Verify payment
- const { amount, status } = paymentData;
- // If amount matches. Processed amount === Requested amount
- if (amount === amountToBePaid) {
- await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Save payment info to DB
- ...
- switch (status) {
- case "ready": // Issue virtual account
- // Save virtual account info in DB
- const { vbank_num, vbank_date, vbank_name } = paymentData;
- await Users.findByIdAndUpdate("/* customer id */", { $set: { vbank_num, vbank_date, vbank_name }});
- // Send virtual account issuance text message
- SMS.send({ text: \`Virtual account issued successfully. Account info \${vbank_num} \${vbank_date} \${vbank_name}\`});
- res.send({ status: "vbankIssued", message: "Virtual account issued successfully" });
- break;
- case "paid": // Payment complete
- res.send({ status: "success", message: "General payment successful" });
- break;
- }
- } else { // Amount mismatch. Forged/falsified payment.
- throw { status: "forgery", message: "Forged/falsified payment attempted" };
+ app.post("/payments/complete", async (req, res) => {
+ try {
+ // Get imp_uid, merchant_uid from req.body
+ const { imp_uid, merchant_uid } = req.body;
+ console.log(imp_uid, merchant_uid);
+ // Get access token
+ /* ...Omitted... */
+ // Get payment info from iamport server using imp_uid
+ /* ...Omitted... */
+ const paymentData = getPaymentData.data.response; // Payment info
+ // Get the requested payment amount from the DB
+ const order = await Orders.findById(paymentData.merchant_uid);
+ const amountToBePaid = order.amount; // Requested payment amount
+ // Verify payment
+ const { amount, status } = paymentData;
+ // If amount matches. Processed amount === Requested amount
+ if (amount === amountToBePaid) {
+ await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Save payment info to DB
+ switch (status) {
+ case "ready": // Issue virtual account
+ // Save virtual account info in DB
+ const { vbank_num, vbank_date, vbank_name } = paymentData;
+ await Users.findByIdAndUpdate("/* customer id */", {
+ $set: { vbank_num, vbank_date, vbank_name },
+ });
+ // Send virtual account issuance text message
+ SMS.send({
+ text: `Virtual account issued successfully. Account info ${vbank_num} ${vbank_date} ${vbank_name}`,
+ });
+ res.send({
+ status: "vbankIssued",
+ message: "Virtual account issued successfully",
+ });
+ break;
+ case "paid": // Payment complete
+ res.send({
+ status: "success",
+ message: "General payment successful",
+ });
+ break;
}
- } catch (e) {
- res.status(400).send(e);
+ } else {
+ // Amount mismatch. Forged/falsified payment.
+ throw {
+ status: "forgery",
+ message: "Forged/falsified payment attempted",
+ };
}
- });
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
diff --git a/src/content/docs/en/auth/guide/6.mdx b/src/content/docs/en/auth/guide/6.mdx
index 9dd2dd4f6..b04751481 100644
--- a/src/content/docs/en/auth/guide/6.mdx
+++ b/src/content/docs/en/auth/guide/6.mdx
@@ -16,55 +16,69 @@ following example.
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
- // jQuery HTTP request
- jQuery.ajax({
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
+ // jQuery HTTP request
+ jQuery
+ .ajax({
/* ...Omitted... */
- }).done(function(data) { // response processing
- switch(data.status) {
- case: "vbankIssued":
+ })
+ .done(function (data) {
+ // response processing
+ switch (data.status) {
+ case "vbankIssued":
// Virtual account issued
break;
- case: "success":
+ case "success":
// Payment successful
break;
}
});
} else {
- alert("Payment failed. Error message: " + rsp.error_msg);
+ alert("Payment failed. Error message: " + rsp.error_msg);
}
- });
+ },
+ );
```
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
// axios HTTP request
axios({
/* ...Omitted... */
- }).then((data) => { // Response processing
- switch(data.status) {
- case: "vbankIssued":
+ }).then((data) => {
+ // Response processing
+ switch (data.status) {
+ case "vbankIssued":
// Virtual account issued
break;
- case: "success":
+ case "success":
// Payment successful
break;
}
});
} else {
- alert(\`Payment failed. Error message: \${rsp.error_msg}\`);
+ alert(`Payment failed. Error message: ${rsp.error_msg}`);
}
- });
+ },
+ );
```
diff --git a/src/content/docs/en/auth/guide/def.mdx b/src/content/docs/en/auth/guide/def.mdx
index e3deb6c30..c70a2726b 100644
--- a/src/content/docs/en/auth/guide/def.mdx
+++ b/src/content/docs/en/auth/guide/def.mdx
@@ -19,7 +19,8 @@ authentication result.
Communication for a live payment request is made directly between the merchant server and the PG server, and card information is not used in the payment request process.
-#### Authenticated payment is traditionally categorized into the following two types based on the authentication method.
+Authenticated payment is traditionally categorized into the followingtwo types
+based on the authentication method.
- ISP: authenticates pre-registered card information through a public key-based digital certificate
- MPI: authenticates card information by entering the card number, CVC, and secure click password.
@@ -29,4 +30,4 @@ to pre-register a credit card and use the **6-digit payment password** to easily
-#### You can easily integrate authenticated payment through i'mport!
+You can easily integrate authenticated payment through i'mport!
diff --git a/src/content/docs/en/auth/guide/readme.mdx b/src/content/docs/en/auth/guide/readme.mdx
index 8aae9ffd1..ed0c60b7f 100644
--- a/src/content/docs/en/auth/guide/readme.mdx
+++ b/src/content/docs/en/auth/guide/readme.mdx
@@ -23,7 +23,8 @@ authentication result.
Communication for a live payment request is made directly between the merchant server and the PG server, and card information is not used in the payment request process.
-#### Authenticated payment is traditionally categorized into the following two types based on the authentication method.
+Authenticated payment is traditionally categorized into the following two types
+based on the authentication method.
- ISP: authenticates pre-registered card information through a public key-based digital certificate
- MPI: authenticates card information by entering the card number, CVC, and secure click password.
@@ -33,7 +34,7 @@ to pre-register a credit card and use the **6-digit payment password** to easily
-#### You can easily integrate authenticated payments through i'mport!
+You can easily integrate authenticated payments through i'mport!
## 1. Add i'mport library
@@ -58,20 +59,20 @@ Add the JS library to your checkout page.
## 2. Initialize IMP object
-#### On the checkout page, initialize the IMP object using your [Merchant ID](../../ready/3.).
+On the checkout page, initialize the IMP object using your [Merchant ID](../../ready/3.).
- ```javascript title="Client-side"
- var IMP = window.IMP; // Can be omitted
- IMP.init("Merchant ID"); // Example: imp00000000
+ ```ts title="Client-side"
+ const IMP = window.IMP; // Can be omitted
+ IMP.init("Merchant ID"); // Example: imp00000000
```
- ```javascript title="Client-side"
- const IMP = window.IMP; // Can be omitted
- IMP.init("{Merchant ID}"); // Example: imp00000000a
+ ```ts title="Client-side"
+ const IMP = window.IMP; // Can be omitted
+ IMP.init("{Merchant ID}"); // Example: imp00000000a
```
@@ -89,41 +90,39 @@ the first argument of the **request\_pay** function.
- ```javascript
-
+ },
+ );
```
- ```jsx
- class RequestPay extends React.Component {
- requestPay = () => {
- IMP.request_pay({ // param
+ ```tsx
+ export class RequestPay extends React.Component {
+ requestPay = () => {
+ IMP.request_pay(
+ {
+ // param
pg: "kcp",
pay_method: "card",
merchant_uid: "ORD20180131-0000011",
@@ -133,54 +132,53 @@ the first argument of the **request\_pay** function.
buyer_name: "Hong Gildong",
buyer_tel: "010-4242-4242",
buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "01181"
- }, rsp => { // callback
+ buyer_postcode: "01181",
+ },
+ (rsp) => {
+ // callback
if (rsp.success) {
- ...,
// Payment is successful
- ...
} else {
- ...,
// Payment failed
- ...
}
- });
- }
+ },
+ );
+ };
+ }
```
- ```javascript
-
+ ```ts
+ export default {
+ methods: {
+ requestPay: function () {
+ IMP.request_pay(
+ {
+ // param
+ pg: "kcp",
+ pay_method: "card",
+ merchant_uid: "ORD20180131-0000011",
+ name: "Norway swivel chair",
+ amount: 64900,
+ buyer_email: "gildong@gmail.com",
+ buyer_name: "Hong Gildong",
+ buyer_tel: "010-4242-4242",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "01181",
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // Payment is successful
+ } else {
+ // Payment failed
+ }
+ },
+ );
+ },
+ },
+ };
```
@@ -188,11 +186,11 @@ the first argument of the **request\_pay** function.
**Note - Creating an order ID (merchant\_uid)**
- - The order number must always be assigned a **unique** **value** each time the payment window is requested.
+ - The order number must always be assigned a **unique value** each time the payment window is requested.
- After the payment process is complete, the server uses the order ID to retrieve the order information for **payment fraud check**. Be sure to create a **unique ID** on the merchant server and **store it in the DB**.
-#### The following is the above sample code with the Pay button added.
+The following is the above sample code with the Pay button added.
```html title="sample.html"
@@ -263,7 +261,8 @@ the payment window type as follows:
-#### Most payments that are processed in the PC environment can receive payment results through the callback function, which is the second argument of the request\_pay() function.
+Most payments that are processed in the PC environment can receive payment results
+through the callback function, which is the second argument of the request\_pay() function.
For **PayPal** payments, the payment window is loaded as a **pop-up (new window)** in a PC environment and you can also receive the payment result through **m\_redirect\_url**.
@@ -274,36 +273,47 @@ the payment window type as follows:
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
- // HTTP request with jQuery
- jQuery.ajax({
- url: "{Merchant endpoint that receives server's payment info}",
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: {
- imp_uid: rsp.imp_uid, // Payment ID
- merchant_uid: rsp.merchant_uid // Order ID
- }
- }).done(function (data) {
- // Merchant server payment API call is successful
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
+ // HTTP request with jQuery
+ jQuery
+ .ajax({
+ url: "{Merchant endpoint that receives server's payment info}",
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: {
+ imp_uid: rsp.imp_uid, // Payment ID
+ merchant_uid: rsp.merchant_uid, // Order ID
+ },
})
- } else {
- alert("Payment failed. Error: " + rsp.error_msg);
- }
- });
+ .done(function (data) {
+ // Merchant server payment API call is successful
+ console.log(data);
+ });
+ } else {
+ alert("Payment failed. Error: " + rsp.error_msg);
+ }
+ },
+ );
```
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) {
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
// HTTP request with axios
axios({
url: "{Endpoint that receives server's payment info}",
@@ -311,15 +321,17 @@ the payment window type as follows:
headers: { "Content-Type": "application/json" },
data: {
imp_uid: rsp.imp_uid,
- merchant_uid: rsp.merchant_uid
- }
+ merchant_uid: rsp.merchant_uid,
+ },
}).then((data) => {
// Server payment API call is successful
- })
+ console.log(data);
+ });
} else {
- alert(\`Payment failed. Error: \${rsp.error_msg}\`);
+ alert(`Payment failed. Error: ${rsp.error_msg}`);
}
- });
+ },
+ );
```
@@ -344,20 +356,26 @@ above.
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */,
- m_redirect_url: "{redirect URL}"
- }, /* callback */); // callback is not called
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ m_redirect_url: "{redirect URL}",
+ },
+ /* callback */
+ ); // callback is not called
```
- ```javascript title="client-side"
- IMP.request_pay({
- /* ...Omitted... */,
- m_redirect_url: "{redirect URL}"
- }, /* callback */); // callback is not called
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
+ /* ...Omitted... */
+ m_redirect_url: "{redirect URL}",
+ },
+ /* callback */
+ ); // callback is not called
```
@@ -369,13 +387,13 @@ The following is an example of redirecting URL based on the query string.
- ```url
+ ```sh
curl https://myservice.com/payments/complete?imp_uid=unique_iamport_paymentID&merchant_uid=unique_merchant_orderID&imp_success=true
```
- ```
+ ```sh
curl https://myservice.com/payments/complete?imp_uid=unique_iamport_paymentID&merchant_uid=unique_merchant_orderID&imp_success=false&error_code=error_code(none_defined_currently)&error_msg=error_message
```
@@ -398,19 +416,28 @@ The following is an example of redirecting URL based on the query string.
> The `payment process is complete` when:
>
> 1. **Payment is successful** (Status: `paid`, imp\_success: `true`)
+>
> 2. **Payment fails** (Status: `failed`, imp\_success: `false`)
+>
> 3. **Payment window fails to open** due to PG module setting error
+>
> 4. User **terminates the payment process** by clicking the X or Cancel button
-> 5. **Payment is suspended** due to invalid card information, limit exceeded, insufficient balance, etc.
+>
+> 5. **Payment is suspended** due to invalid card information,
+> limit exceeded, insufficient balance, etc.
+>
> 6. **Virtual account is issued** (status: `ready`, imp\_success: `true`)
- The final payment result logic processing must be handled stably by using a [**webhook**](../../result/webhook). If you don't set up a webhook, you may fail to receive the payment result.
+ The final payment result logic processing must be handled stably by using a [**webhook**](../../result/webhook).
+ If you don't set up a webhook, you may fail to receive the payment result.
## 5. Verify payment information
-Based on the payment information from the client, the server verifies the **payment amount for fraud** and saves the payment information in the database if needed. The following are the steps for verifying the payment information.
+Based on the payment information from the client, the server verifies the **payment amount for fraud**
+and saves the payment information in the database if needed.
+The following are the steps for verifying the payment information.
- Server receives the i'mport payment ID (**imp\_uid**) and order ID (**merchant\_uid**)
@@ -426,7 +453,7 @@ Based on the payment information from the client, the server verifies the
Example of handling a POST request to the merchant endpoint URL that receives the payment information
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
// "{Merchant endpoint that receives server's payment info}" POST request receiver
app.post("/payments/complete", async (req, res) => {
@@ -447,41 +474,38 @@ Based on the payment information from the client, the server verifies the
Example of calling the [**Get payment**](https://api.iamport.kr/#!/payments/getPaymentByImpUid) **API** with the i'mport **payment ID (imp\_uid)** to retrieve the payment info.
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
- ...
- app.post("/payments/complete", async (req, res) => {
- try {
- // Get imp_uid, merchant_uid from req.body
- const { imp_uid, merchant_uid } = req.body;
- ...
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" },
- data: {
- imp_key: "imp_apikey", // REST API key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // access token
- ...
- // Get payment info from i'mport server using imp_uid
- const getPaymentData = await axios({
- // Pass imp_uid
- url: \`https://api.iamport.kr/payments/\${imp_uid}\`,
- // GET method
- method: "get",
- // Add access toke to Authorization header
- headers: { "Authorization": access_token }
- });
- const paymentData = getPaymentData.data.response; // Payment info
- ...
- } catch (e) {
- res.status(400).send(e);
- }
+ app.post("/payments/complete", async (req, res) => {
+ try {
+ // Get imp_uid, merchant_uid from req.body
+ const { imp_uid, merchant_uid } = req.body;
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" },
+ data: {
+ imp_key: "imp_apikey", // REST API key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // access token
+ // Get payment info from i'mport server using imp_uid
+ const getPaymentData = await axios({
+ // Pass imp_uid
+ url: `https://api.iamport.kr/payments/${imp_uid}`,
+ // GET method
+ method: "get",
+ // Add access toke to Authorization header
+ headers: { Authorization: access_token },
});
+ const paymentData = getPaymentData.data.response; // Payment info
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
@@ -504,56 +528,66 @@ Based on the payment information from the client, the server verifies the
Example of comparing the actual payment amount and the payment request amount, performing fraud check on the payment amount, and saving the data in the DB.
- ```javascript title="server-side"
+ ```ts title="server-side"
app.use(bodyParser.json());
- ...
- app.post("/payments/complete", async (req, res) => {
- try {
- // Get imp_uid, merchant_uid from req.body
- const { imp_uid, merchant_uid } = req.body;
- // Get access token
- /* ...Omitted... */
- // Get payment info from iamport server using imp_uid
- /* ...Omitted... */
- const paymentData = getPaymentData.data.response; // Payment info
- ...
- // Get the requested payment amount from the DB
- const order = await Orders.findById(paymentData.merchant_uid);
- const amountToBePaid = order.amount; // Requested payment amount
- ...
- // Verify payment
- const { amount, status } = paymentData;
- // If amount matches. Processed amount === Requested amount
- if (amount === amountToBePaid) {
- await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Save payment info to DB
- ...
- switch (status) {
- case "ready": // Issue virtual account
- // Save virtual account info in DB
- const { vbank_num, vbank_date, vbank_name } = paymentData;
- await Users.findByIdAndUpdate("/* customer id */", { $set: { vbank_num, vbank_date, vbank_name }});
- // Send virtual account issuance text message
- SMS.send({ text: \`Virtual account issued successfully. Account info \${vbank_num} \${vbank_date} \${vbank_name}\`});
- res.send({ status: "vbankIssued", message: "Virtual account issued successfully" });
- break;
- case "paid": // Payment complete
- res.send({ status: "success", message: "General payment successful" });
- break;
- }
- } else { // Amount mismatch. Forged/falsified payment.
- throw { status: "forgery", message: "Forged/falsified payment attempted" };
+ app.post("/payments/complete", async (req, res) => {
+ try {
+ // Get imp_uid, merchant_uid from req.body
+ const { imp_uid, merchant_uid } = req.body;
+ // Get access token
+ /* ...Omitted... */
+ // Get payment info from iamport server using imp_uid
+ /* ...Omitted... */
+ const paymentData = getPaymentData.data.response; // Payment info
+ // Get the requested payment amount from the DB
+ const order = await Orders.findById(paymentData.merchant_uid);
+ const amountToBePaid = order.amount; // Requested payment amount
+ // Verify payment
+ const { amount, status } = paymentData;
+ // If amount matches. Processed amount === Requested amount
+ if (amount === amountToBePaid) {
+ await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Save payment info to DB
+ switch (status) {
+ case "ready": // Issue virtual account
+ // Save virtual account info in DB
+ const { vbank_num, vbank_date, vbank_name } = paymentData;
+ await Users.findByIdAndUpdate("/* customer id */", {
+ $set: { vbank_num, vbank_date, vbank_name },
+ });
+ // Send virtual account issuance text message
+ SMS.send({
+ text: `Virtual account issued successfully. Account info ${vbank_num} ${vbank_date} ${vbank_name}`,
+ });
+ res.send({
+ status: "vbankIssued",
+ message: "Virtual account issued successfully",
+ });
+ break;
+ case "paid": // Payment complete
+ res.send({
+ status: "success",
+ message: "General payment successful",
+ });
+ break;
}
- } catch (e) {
- res.status(400).send(e);
+ } else {
+ // Amount mismatch. Forged/falsified payment.
+ throw {
+ status: "forgery",
+ message: "Forged/falsified payment attempted",
+ };
}
- });
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
```
The original requested amount is queried from the database with the **`merchant_uid`**, and the
actual processed amount is retrieved from the i'mport server with the **`imp_uid`**. The **two
-values are compared** to verify that they match. **If the verification is successful,
+values are compared** to verify that they match. **If the verification is successful,
the payment information is saved in the database** and a response is returned based on the payment
status (**`status`**). Otherwise, an error message is returned.
@@ -570,57 +604,69 @@ example.
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
- // jQuery HTTP request
- jQuery.ajax({
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
+ // jQuery HTTP request
+ jQuery
+ .ajax({
/* ...Omitted... */
- }).done(function(data) { // response processing
- switch(data.status) {
- case: "vbankIssued":
+ })
+ .done(function (data) {
+ // response processing
+ switch (data.status) {
+ case "vbankIssued":
// Virtual account issued
break;
- case: "success":
+ case "success":
// Payment successful
break;
}
});
} else {
- alert("Payment failed. Error message: " + rsp.error_msg);
+ alert("Payment failed. Error message: " + rsp.error_msg);
}
- });
+ },
+ );
```
- ```javascript title="client-side"
- IMP.request_pay({
+ ```ts title="client-side"
+ IMP.request_pay(
+ {
/* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) { // payment successful: payment accepted or virtual account issued
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // payment successful: payment accepted or virtual account issued
// axios HTTP request
axios({
/* ...Omitted... */
- }).then((data) => { // Response processing
- switch(data.status) {
- case: "vbankIssued":
+ }).then((data) => {
+ // Response processing
+ switch (data.status) {
+ case "vbankIssued":
// Virtual account issued
break;
- case: "success":
+ case "success":
// Payment successful
break;
}
});
} else {
- alert(\`Payment failed. Error message: \${rsp.error_msg}\`);
+ alert(`Payment failed. Error message: ${rsp.error_msg}`);
}
-
- });
-
+ },
+ );
```
@@ -633,6 +679,3 @@ payment complete message from the merchant endpoint URL** set in the **m\_redire
These parameters are returned as a response when the payment fails and they contains the same values returned from the PG without additional processing. Note that we don't yet provide definitions for the error codes and error messages that have accumulated in our system.
-
-```
-```
diff --git a/src/content/docs/en/console/guide/account.mdx b/src/content/docs/en/console/guide/account.mdx
index 56131d136..a59155bb7 100644
--- a/src/content/docs/en/console/guide/account.mdx
+++ b/src/content/docs/en/console/guide/account.mdx
@@ -10,12 +10,28 @@ import Figure from "~/components/Figure.astro";
## i'mport Admin console accounts
-- Merchant Admin account (Admin): The Merchant Admin account that is created when a merchant signs up in the Admin console. This account has access to all features.
-- Merchant Manager account (Manager): The Merchant Admin account can create and issue this account. This account only has read-only access to merchant/account management and integration, but has full access to any other features.
-- Merchant Developer account (Dev): The Merchant Manager account can create and issue this account. This account has full access to the integration feature, only read-only access to merchant account management, and access to no other features.
-- Merchant User account (Read Only): The Merchant Manager account can create and issue this account. This account has read-only access to all features.
-- Sub-merchant Manager account (Manager): The Merchant Manager account or its Sub-merchant Manager account can create and issue this account. This account has access to all features of the sub-merchant, and read-only access to the Merchant Admin account and merchant's business information.
-- Sub-merchant User account (Read Only): The Merchant Admin account or its Sub-merchant Manager account can create and issue this account. This account has read-only access to all features of the sub-merchant.
+- Merchant Admin account (Admin): The Merchant Admin account that is created
+ when a merchant signs up in the Admin console. This account has access to all features.
+
+- Merchant Manager account (Manager): The Merchant Admin account can create and issue this account.
+ This account only has read-only access to merchant/account management and integration,
+ but has full access to any other features.
+
+- Merchant Developer account (Dev): The Merchant Manager account can create and issue this account.
+ This account has full access to the integration feature,
+ only read-only access to merchant account management, and access to no other features.
+
+- Merchant User account (Read Only): The Merchant Manager account can create and issue this account.
+ This account has read-only access to all features.
+
+- Sub-merchant Manager account (Manager): The Merchant Manager account
+ or its Sub-merchant Manager account can create and issue this account.
+ This account has access to all features of the sub-merchant,
+ and read-only access to the Merchant Admin account and merchant's business information.
+
+- Sub-merchant User account (Read Only): The Merchant Admin account
+ or its Sub-merchant Manager account can create and issue this account.
+ This account has read-only access to all features of the sub-merchant.
## Admin account management
@@ -23,41 +39,50 @@ _Available menus/buttons are marked in blue._
-
+
+
+- The Admin account can create, issue, modify roles and information,
+ and delete accounts under the merchant.
-- The Admin account can create, issue, modify roles and information, and delete accounts under the merchant.
- Non-admin accounts can only view the accounts under the merchant.
![]()
## Merchant and sub-merchant accounts
-- Merchant: A business with a unique business registration number except for agencies that develop payment service for other merchants.
-- Sub-merchant: Merchants can manage and integrate payments through the Admin console by dividing its business by service, product line, region, etc. Such a division is defined as a sub-merchant.
- - Payment integration: The merchant can assign its payment methods and PGs to a specific sub-merchant from the Admin console.
- - Sub-merchant account: Sub-merchant accounts are limited to read-only access to features and payments associated with the sub-merchant.
+- Merchant: A business with a unique business registration number
+ except for agencies that develop payment service for other merchants.
+
+- Sub-merchant: Merchants can manage and integrate payments through the Admin console
+ by dividing its business by service, product line, region, etc.
+ Such a division is defined as a sub-merchant.
+
+ - Payment integration: The merchant can assign its payment methods and PGs
+ to a specific sub-merchant from the Admin console.
+
+ - Sub-merchant account: Sub-merchant accounts are limited to read-only access
+ to features and payments associated with the sub-merchant.
## Sub-merchant management
### Merchant Admin account view
-
+
-- The Merchant Admin account can add and edit sub-merchants and create, edit, and delete accounts belonging to the sub-merchant.
+- The Merchant Admin account can add and edit sub-merchants
+ and create, edit, and delete accounts belonging to the sub-merchant.
#### Add/edit sub-merchant
![]()![]()
-- To add a sub-merchant, enter the sub-merchant name, payment channel, service url, contact information, and tier code.
- - The payment channel is assigned through the online payment application, and it can be assigned to a merchant in payment integration.
+- To add a sub-merchant, enter the sub-merchant name, payment channel,
+ service url, contact information, and tier code.
+ - The payment channel is assigned through the online payment application,
+ and it can be assigned to a merchant in payment integration.
+
- A payment channel already assigned to another sub-merchant cannot be assigned.
+
- To call the i'mport Payment SDK from the sub-merchant's URL, use the tier code and call `import.agency (‘tier code’)`.
#### Add sub-merchant account
@@ -68,17 +93,8 @@ _Available menus/buttons are marked in blue._
### Non-admin account view
-
+
-
+
-
+
diff --git a/src/content/docs/en/console/guide/list.mdx b/src/content/docs/en/console/guide/list.mdx
index a872384b0..3b559d11d 100644
--- a/src/content/docs/en/console/guide/list.mdx
+++ b/src/content/docs/en/console/guide/list.mdx
@@ -5,116 +5,169 @@ description: Check the details of each payment transaction.
Payment activity page
-* Filter payments by date range during which payment was attempted.
-* Perform comprehensive search by specifying a search condition or for all data if no condition is specified.
-* Filter payments by payment status, method, PG, type, and mode.
-* Total search results by status.
-* Payment activity list that shows payment status, customer information, payment method, PG, payment amount, mode, request time, and completion time.
-* Click the right corner of a payment record in the list to copy MID, UID or cancel payment.
-* Click on a payment to view its details.
-* Click on a payment to cancel it.
-* Click on a payment to resend a webhook.
-* Total transaction amount of search results - Total sales by currency calculated based on the total refund amount.
-* Excel download of basic payment details and selected additional data including customer, PG, credit card payment, and account transfer payment information.
+- Filter payments by date range during which payment was attempted.
+
+- Perform comprehensive search by specifying a search condition
+ or for all data if no condition is specified.
+
+- Filter payments by payment status, method, PG, type, and mode.
+
+- Total search results by status.
+
+- Payment activity list that shows payment status, customer information, payment method,
+ PG, payment amount, mode, request time, and completion time.
+
+- Click the right corner of a payment record in the list to copy MID, UID or cancel payment.
+
+- Click on a payment to view its details.
+
+- Click on a payment to cancel it.
+
+- Click on a payment to resend a webhook.
+
+- Total transaction amount of search results - Total sales by currency
+ calculated based on the total refund amount.
+
+- Excel download of basic payment details and selected additional data
+ including customer, PG, credit card payment, and account transfer payment information.
## Calendar filter
![]()
-* Specify the start and end date/time of the payment request to search for.
- * A payment request occurs when a customer attempts to make a payment.
- * Hence, the time of refund and completion may occur outside of the specified search period.
-* You can specify the year, month, day, hour, and minute.
-* For convenience, you can quickly set the dates using the buttons for today, yesterday, past 7 days, 30 days, or 90 days.
-* You can also manually enter the dates.
+- Specify the start and end date/time of the payment request to search for.
+ - A payment request occurs when a customer attempts to make a payment.
+ - Hence, the time of refund and completion may occur outside of the specified search period.
+
+- You can specify the year, month, day, hour, and minute.
+
+- For convenience, you can quickly set the dates using the buttons
+ for today, yesterday, past 7 days, 30 days, or 90 days.
+
+- You can also manually enter the dates.
## Comprehensive search
![]()
-* Perform a search by specifying a filter or on all payment data.
-* Comprehensive search filters:
- * i'mport transaction number
- * Merchant transaction number
- * Credit card approval number
- * Customer name
- * Customer mobile number
- * Customer email
- * PG approval number
- * Credit card number
- * Merchant ID
- * Payment environment
- * Live account bank
- * Virtual account bank
- * Bank account number
- * Name of depositor
- * Cash receipt issuance number
- * Customer address
- * Reason for cancellation
- * Payment environment details
- * Order name
-* The search logic is specified as 'like %value' that returns the values that start with the specified value.
- * In the future, the order name and customer address will be changed to 'like %value%'.
+- Perform a search by specifying a filter or on all payment data.
+
+- Comprehensive search filters:
+ - i'mport transaction number
+ - Merchant transaction number
+ - Credit card approval number
+ - Customer name
+ - Customer mobile number
+ - Customer email
+ - PG approval number
+ - Credit card number
+ - Merchant ID
+ - Payment environment
+ - Live account bank
+ - Virtual account bank
+ - Bank account number
+ - Name of depositor
+ - Cash receipt issuance number
+ - Customer address
+ - Reason for cancellation
+ - Payment environment details
+ - Order name
+
+- The search logic is specified as 'like %value' that returns the values
+ that start with the specified value.
+ - In the future, the order name and customer address will be changed to 'like %value%'.
## Filters
![]()
-* You can search payments by filtering on payment status, payment method, PG, payment type, and payment mode.
- * Payment status: All, Scheduled, Completed, Cancelled (full), Cancelled (partial), Failed
- * Payment method: Payment method
- * PG: PG
- * Payment type: All, subscription, general
- * Payment mode: All, live, test
+- You can search payments by filtering on payment status, payment method,
+ PG, payment type, and payment mode.
+ - Payment status: All, Scheduled, Completed, Cancelled (full), Cancelled (partial), Failed
+ - Payment method: Payment method
+ - PG: PG
+ - Payment type: All, subscription, general
+ - Payment mode: All, live, test
## Total payments by status
![]()
-* Shows payment totals by status (all, completed, scheduled, failed, and cancelled).
- * Failed payments include partial and full cancellations.
+- Shows payment totals by status (all, completed, scheduled, failed, and cancelled).
+ - Failed payments include partial and full cancellations.
## Payment activity list
-
+
+
+
+
+
+
+- Payment activity list shows results from a date range, comprehensive, or data filter search.
+
+- The default view shows all payment data for the last 6 months.
-* Payment activity list shows results from a date range, comprehensive, or data filter search.
-* The default view shows all payment data for the last 6 months.
-* The list shows the payment status, customer information, payment method, PG, payment amount, payment type, request time, and approval time.
- * Customer information includes the customer's name, email, and phone number (displayed in order) that are specified at payment request via SDK.
- * Payment type is general, subscription, or test.
-* Request and approval times are displayed in descending order, and you can click on either value to sort based the value.
-* If you click on the the dots to the right of a payment row in the Payment activity list, you can copy the merchant transaction number (merchant\_uid) and i'mport transaction number (imp\_uid). You can also cancel a completed or cancelled (partial) payment.
+- The list shows the payment status, customer information, payment method, PG,
+ payment amount, payment type, request time, and approval time.
+
+ - Customer information includes the customer's name, email, and phone number (displayed in order)
+ that are specified at payment request via SDK.
+
+ - Payment type is general, subscription, or test.
+
+- Request and approval times are displayed in descending order,
+ and you can click on either value to sort based the value.
+
+- If you click on the the dots to the right of a payment row in the Payment activity list, you can
+ copy the merchant transaction number (merchant\_uid) and i'mport transaction number (imp\_uid).
+ You can also cancel a completed or cancelled (partial) payment.
## Payment details
![]()
-* The Payment details page consists of the customer and payment information sections.
-* Customer information shows the customer's name, phone number, e-mail, and address submitted via SDK.
-* Payment information shows:
- * Payment status
- * i'mport transaction number
- * Each payment method shows:
- * Credit card: acquirer and masked card number
- * Virtual account: account bank, account holder, account number, and time of deposit
- * Bank transfer: account bank
- * Mobile micropayment: carrier
- * Total payment amount
- * Order amount - discount amount
- * Order amount
- * List price (VAT)
- * Paid with points
- * Paid with points refers to the points rewarded by simple payment companies and PGs.
- * Discount amount
- * Value retrieved from PG's message. Note that the availability of this data varies by PG.
- * Credit card approval number
- * Merchant ID
- * PG
- * PG approval number
- * Payment ID assigned by the PG.
- * Payment environment
- * Parsed device and web/app environment information
+- The Payment details page consists of the customer and payment information sections.
+
+- Customer information shows the customer's name, phone number,
+ e-mail, and address submitted via SDK.
+
+- Payment information shows:
+
+ - Payment status
+
+ - i'mport transaction number
+
+ - Each payment method shows:
+ - Credit card: acquirer and masked card number
+ - Virtual account: account bank, account holder, account number, and time of deposit
+ - Bank transfer: account bank
+ - Mobile micropayment: carrier
+
+ - Total payment amount
+ - Order amount - discount amount
+
+ - Order amount
+
+ - List price (VAT)
+
+ - Paid with points
+ - Paid with points refers to the points rewarded by simple payment companies and PGs.
+
+ - Discount amount
+ - Value retrieved from PG's message. Note that the availability of this data varies by PG.
+
+ - Credit card approval number
+
+ - Merchant ID
+
+ - PG
+
+ - PG approval number
+ - Payment ID assigned by the PG.
+
+ - Payment environment
+ - Parsed device and web/app environment information
## Payment cancellation
@@ -122,17 +175,26 @@ Payment activity page
![]()
-* You can cancel a payment from the Payment details page of a completed or partially cancelled payment.
-* The default setting is full refund. If you want a partial refund, you can directly edit the refund amount or click `Partial refund` to edit and then click `Cancel Payment` at the bottom to finish.
-* When you cancel a payment, the reason for cancellation is saved and sent to i'mport and PG.
-* If a payment to cancel includes tax-free amount, you can specify this amount in the provided input field.
-* When you cancel from the Admin console, a webhook is sent to the merchant's database for status update.
-* For virtual accounts, you can additionally enter the following refund account information:
- * Refund account bank
- * Refund bank account number
- * Refund account holder
+- You can cancel a payment from the Payment details page
+ of a completed or partially cancelled payment.
+
+- The default setting is full refund. If you want a partial refund,
+ you can directly edit the refund amount or click `Partial refund`
+ to edit and then click `Cancel Payment` at the bottom to finish.
+
+- When you cancel a payment, the reason for cancellation is saved and sent to i'mport and PG.
+
+- If a payment to cancel includes tax-free amount,
+ you can specify this amount in the provided input field.
+
+- When you cancel from the Admin console, a webhook is sent
+ to the merchant's database for status update.
+
+- For virtual accounts, you can additionally enter the following refund account information:
+ - Refund account bank
+ - Refund bank account number
+ - Refund account holder
## Resend webhook
![]()
-
diff --git a/src/content/docs/en/console/guide/readme.mdx b/src/content/docs/en/console/guide/readme.mdx
index 5a137d559..c54850f51 100644
--- a/src/content/docs/en/console/guide/readme.mdx
+++ b/src/content/docs/en/console/guide/readme.mdx
@@ -10,11 +10,11 @@ i'mport Admin console: [https://admin.iamport.kr/](https://admin.iamport.kr/)
## Apply for online payment
-### [Apply for online payment](reg)
+### [Apply for online payment](reg)
## Merchant and account management
-### [My ID & API Keys](my-id-and-api-keys)
+### [My ID & API Keys](my-id-and-api-keys)
### [Manage admin & sub-merchant accounts](account)
diff --git a/src/content/docs/en/console/pg.mdx b/src/content/docs/en/console/pg.mdx
index b0057255d..9e135be80 100644
--- a/src/content/docs/en/console/pg.mdx
+++ b/src/content/docs/en/console/pg.mdx
@@ -4,56 +4,58 @@ description: Learn how to set up and use multiple PGs.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Set up multiple PGs in the i'mport **Admin console** and open a payment window for the desired payment method.
+Set up multiple PGs in the i'mport **Admin console**
+and open a payment window for the desired payment method.
-### 1. Configure authenticated payment (general)
+## 1. Configure authenticated payment (general)
-Go to [**i'mport Admin Console > System Settings > PG Settings tab > Default PG tab**](https://admin.iamport.kr/settings#tab_pg) to set the `default PG` that is used as the default `param.pg` value when you call [`IMP.request_pay`](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay) to open the payment window. The default value is used when the `pg` value is missing or invalid.
+Go to [**i'mport Admin Console > System Settings > PG Settings tab > Default PG tab**](https://admin.iamport.kr/settings#tab_pg)
+to set the `default PG` that is used as the default `param.pg` value
+when you call [`IMP.request_pay`](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay)
+to open the payment window. The default value is used when the `pg` value is missing or invalid.
-
+
-### 2. Add PG for subscription payment (for non-authenticated/**PG payment window)**
+## 2. Add PG for subscription payment (for non-authenticated/**PG payment window)**
-After acquiring a separate Merchant ID (MID) for subscription (non-authenticated) payment from the PG, use it to add the PG from the [**i'mport Admin Console > System Settings > PG Settings (general/subscription) tab**](https://admin.iamport.kr/settings#tab_pg).
+After acquiring a separate Merchant ID (MID) for subscription (non-authenticated) payment
+from the PG, use it to add the PG from the [**i'mport Admin Console > System Settings > PG Settings (general/subscription) tab**](https://admin.iamport.kr/settings#tab_pg).
-### 3. **Add PG for simple payment (Kakao Pay)**
+## 3. **Add PG for simple payment (Kakao Pay)**
Repeat step 2 to add PG setting for Kakao Pay.
-
+
-## Open PG's payment window
+## Open PG's payment window
-To open a PG's payment window, call [**JavaScript SDK**](../sdk/javascript-sdk/) `IMP.request_pay` by specifying the PG that is already configured in **Admin console** in the `param.pg` property.
+To open a PG's payment window, call [**JavaScript SDK**](../sdk/javascript-sdk/) `IMP.request_pay`
+by specifying the PG that is already configured in **Admin console** in the `param.pg` property.
-The [`pg` value](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay) can have the following format:
+The [`pg` value](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay)
+can have the following format:
- **`{ PG code }`**
- **`{ PG code }.{ PG Merchant ID }`**
Assume that we have added **3 PG settings** as follows:
-| PG | Merchant ID | Pay Type | Default PG |
-| --------------- | ----------------- | ---------------- | ---------- |
-| **`KG INICIS`** | `MID-a` (example) | **General** | O |
-| **`KG INICIS`** | `MID-b` (example) | **Subscription** | X |
-| `Kakao Pay` | `MID-c` (example) | Simple | X |
+|PG |Merchant ID |Pay Type |Default PG|
+|---------------|-----------------|----------------|----------|
+|**`KG INICIS`**|`MID-a` (example)|**General** |O |
+|**`KG INICIS`**|`MID-b` (example)|**Subscription**|X |
+|`Kakao Pay` |`MID-c` (example)|Simple |X |
-Of the previously added PG settings, `Kakao Pay` can be identified just with the `PG service code`. Set **`kakaopay`** in the `pg` property for the Kakao Pay payment request as follows:
+Of the previously added PG settings, `Kakao Pay` can be identified just with the `PG service code`.
+Set **`kakaopay`** in the `pg` property for the Kakao Pay payment request as follows:
-```javascript title="client-side"
+```ts title="client-side"
IMP.request_pay({
pg: "kakaopay", //Open Kakao Pay payment page
amount: 1000,
@@ -63,39 +65,39 @@ IMP.request_pay({
});
```
-Of the previously added PG settings, **`KG INICIS (general)`** and **`KG INICIS (subscription)`** have the **same PG service code**. Hence, you need to set `pg` to a value that combines the service code with the Merchant ID, **`{ PG Code }.{ PG Merchant ID }`**.
+Of the previously added PG settings, **`KG INICIS (general)`** and **`KG INICIS (subscription)`**
+have the **same PG service code**.
+Hence, you need to set `pg` to a value that combines the service code with the Merchant ID, **`{ PG Code }.{ PG Merchant ID }`**.
-
-```javascript title="JavaScript"
-IMP.request_pay({
- pg : "html5_inicis.MID-a", // Call KG INICIS general payment window (merchant ID: MID-a)
- amount : 1000,
- name : "Sample order",
- buyer_name : "Buyer",
- buyer_email : "buyer@iamport.kr"
- });
-```
-
-
-
-
-```javascript title="JavaScript"
-IMP.request_pay({
- pg : "html5_inicis.MID-b", // Call KG INICIS subscription payment window (merchant ID: MID-b)
- amount : 1000,
- name : "Sample order",
- buyer_name : "Buyer",
- buyer_email : "buyer@iamport.kr"
- });
-```
-
-
+
+ ```ts title="JavaScript"
+ IMP.request_pay({
+ pg: "html5_inicis.MID-a", // Call KG INICIS general payment window (merchant ID: MID-a)
+ amount: 1000,
+ name: "Sample order",
+ buyer_name: "Buyer",
+ buyer_email: "buyer@iamport.kr",
+ });
+ ```
+
+
+
+ ```ts title="JavaScript"
+ IMP.request_pay({
+ pg: "html5_inicis.MID-b", // Call KG INICIS subscription payment window (merchant ID: MID-b)
+ amount: 1000,
+ name: "Sample order",
+ buyer_name: "Buyer",
+ buyer_email: "buyer@iamport.kr",
+ });
+ ```
+
-**Matching priority for PG**
-
-[`IMP.request_pay`](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay) finds the setting that matches the `pg` value in the order the PG settings are shown in the **Admin console**. It opens the payment window for the first matching PG setting.
+ **Matching priority for PG**
+ [`IMP.request_pay`](https://docs.iamport.kr/en-US/sdk/javascript-sdk#request_pay) finds the setting that matches the `pg` value
+ in the order the PG settings are shown in the **Admin console**. It opens the payment window for the first matching PG setting.
diff --git a/src/content/docs/en/etc/all/get-verification-info.mdx b/src/content/docs/en/etc/all/get-verification-info.mdx
index b7be3f4e7..23fc50d9b 100644
--- a/src/content/docs/en/etc/all/get-verification-info.mdx
+++ b/src/content/docs/en/etc/all/get-verification-info.mdx
@@ -5,82 +5,80 @@ description: >-
purposes.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
Use the **`imp_uid`** obtained through integrated identity verification to get the customer's
verification information.
-### **STEP 01.** Get verification ID (imp_uid) on the server-side
+## **STEP 01.** Get verification ID (imp\_uid) on the server-side
The following server-side code fetches the data returned from identity verification.
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- // Get imp_uid from req.body
- const { imp_uid } = request.body;
-})
-```
-
-
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // controller that handles POST request to "/certifications"
+ app.post("/certifications", async (request, response) => {
+ // Get imp_uid from req.body
+ const { imp_uid } = request.body;
+ });
+ ```
+
+
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // controller that handles GET request to "/certifications/redirect"
+ app.get("/certifications/redirect", async (request, response) => {
+ const { imp_uid } = request.query; // Get imp_uid from req.query
+ });
+ ```
+
+
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // controller that handles GET request to "/certifications/redirect"
- app.get("/certifications/redirect", async (request, response) => {
- const { imp_uid } = request.query; // Get imp_uid from req.query
-})
-```
+## **STEP 02.** Get verification information
-
-
+To get verification information from the i'mport server,
+you must first get a [**REST API access token**](../../api/rest-api-access-token).
+Use the `access token` and `imp_uid` (verification ID)
+to call the **Get identity verification info REST API**
+that returns the verification information as follows:
-### **STEP 02.** Get verification information
-
-To get verification information from the i'mport server, you must first get a [**REST API access token**](../../api/rest-api-access-token). Use the `access token` and `imp_uid` (verification ID) to call the **Get identity verification info REST API** that returns the verification information as follows:
-
-```javascript title="sever-side(Node.js)"
- app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
- data: {
- imp_key: "imp_apikey", // REST API Key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // Access token
- ...
- // Get verification info from i'mport server using imp_uid
- const getCertifications = await axios({
- url: \`https://api.iamport.kr/certifications/\${imp_uid}\`, // Pass imp_uid
- method: "get", // GET method
- headers: { "Authorization": access_token } // Add access token to Authorization header
- });
- const certificationsInfo = getCertifications.data.response; // Save verification info
- ...
- } catch(e) {
- console.error(e);
- }
- });
+```ts title="sever-side(Node.js)"
+app.use(bodyParser.json());
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
+ data: {
+ imp_key: "imp_apikey", // REST API Key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // Access token
+ // Get verification info from i'mport server using imp_uid
+ const getCertifications = await axios({
+ url: `https://api.iamport.kr/certifications/${imp_uid}`, // Pass imp_uid
+ method: "get", // GET method
+ headers: { Authorization: access_token }, // Add access token to Authorization header
+ });
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ } catch (e) {
+ console.error(e);
+ }
+});
```
-### **STEP 03.** Using verification information
+## **STEP 03.** Using verification information
Retrieve the following user information from the verification information and add the necessary
service logic.
@@ -95,33 +93,32 @@ service logic.
such as online social security number.
-Besides what is listed above, other user information, such as foreigner status, is not provided. Kakao's policy prohibits the provision of the CI value when using the Kakao Certificate.
-
+ Besides what is listed above, other user information, such as foreigner status, is not provided.
+ Kakao's policy prohibits the provision of the CI value when using the Kakao Certificate.
Get the user information and use it as needed. For example, you can use it to check age restrictions
as follows:
-```javascript title="Node.js"
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- /* ...Omitted... */
- // Get verification info using imp_uid
- /* ...Omitted... */
- const certificationsInfo = getCertifications.data.response; // Save verification info
- const { name, birth } = certificationsInfo;
- ...
- // Check age restrictions
- if (new Date(birth).getFullYear() <= 1999) {
- // Check successful
- } else {
- // Check failed
- }
- } catch(e) {
- console.error(e);
+```ts title="Node.js"
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ /* ...Omitted... */
+ // Get verification info using imp_uid
+ /* ...Omitted... */
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ const { name, birth } = certificationsInfo;
+ // Check age restrictions
+ if (new Date(birth).getFullYear() <= 1999) {
+ // Check successful
+ } else {
+ // Check failed
}
- });
+ } catch (e) {
+ console.error(e);
+ }
+});
```
diff --git a/src/content/docs/en/etc/all/prepare-for-verification.mdx b/src/content/docs/en/etc/all/prepare-for-verification.mdx
index 20e917d50..4b2a756c7 100644
--- a/src/content/docs/en/etc/all/prepare-for-verification.mdx
+++ b/src/content/docs/en/etc/all/prepare-for-verification.mdx
@@ -3,51 +3,43 @@ title: Prepare for verification
description: Prepare for integrated identity verification integration.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Add the **i'mport library** to the target page.
+## Add the **i'mport library** to the target page.
-Integrated identity verification is supported in **i'mport JavaScript v1.1.8 or later** versions.
-
+ Integrated identity verification is supported in **i'mport JavaScript v1.1.8 or later** versions.
-
-```html title="client-side"
-
-
-
-
-```
-
-
+
+ ```html title="client-side"
+
+
+
+
+ ```
+
-You **must install jQuery 1.0 or later version**.
-
+ You **must install jQuery 1.0 or later version**.
-### Initialize the `IMP` object using the **`Merchant ID`** on the identity verification page.
+## Initialize the `IMP` object using the **`Merchant ID`** on the identity verification page.
-
-```javascript title="client-side"
-var IMP = window.IMP; // Can be omitted
-IMP.init("{Merchant ID}"); // Example: imp00000000
-```
-
-
-
-
-```javascript
-client-side
-const IMP = window.IMP; // Can be omitted
-IMP.init("{Merchant ID}"); // Example: imp00000000
-```
-
-
+
+ ```ts title="client-side"
+ IMP.init("{Merchant ID}"); // Example: imp00000000
+ ```
+
+
+
+ ```ts title="client-side"
+ IMP.init("{Merchant ID}"); // Example: imp00000000
+ ```
+
diff --git a/src/content/docs/en/etc/all/readme.mdx b/src/content/docs/en/etc/all/readme.mdx
index 83400b300..ebabcc8a0 100644
--- a/src/content/docs/en/etc/all/readme.mdx
+++ b/src/content/docs/en/etc/all/readme.mdx
@@ -5,13 +5,15 @@ description: Learn how to integrate integrated identity verification service.
import Figure from "~/components/Figure.astro";
-### What is an integrated identity verification service?
+## What is an integrated identity verification service?
-This is a service that verifies the identity of the person and the accuracy of the information entered during the verification process through a private certificate, such as KakaoTalk and Naver Certificate. Integrated identity verification is provided through **KG Inicis** and processed by using a private certificate or by sending a verification request through the user's registered simple identity verification service.
+This is a service that verifies the identity of the person and the accuracy
+of the information entered during the verification process through a private certificate,
+such as KakaoTalk and Naver Certificate.
+Integrated identity verification is provided through **KG Inicis**
+and processed by using a private certificate or by sending a verification request
+through the user's registered simple identity verification service.
> **Supported providers: Naver / PASS / Payco / TOSS / Financial Certificate / Kakao**
-
+
diff --git a/src/content/docs/en/etc/all/request-verification.mdx b/src/content/docs/en/etc/all/request-verification.mdx
index 172ed832a..888f1ddcb 100644
--- a/src/content/docs/en/etc/all/request-verification.mdx
+++ b/src/content/docs/en/etc/all/request-verification.mdx
@@ -3,10 +3,10 @@ title: Request verification
description: Call the integrated identity verification window.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### The integrated identity verification window can be invoked in the following two modes:
+## The integrated identity verification window can be invoked in the following two modes:
> **Popup** (Default)
>
@@ -28,25 +28,25 @@ The following example calls the JavaScript SDK
to open the integrated identity verification window.
-
-```javascript title="client-side"
- // Call IMP.certification(param, callback)
- IMP.certification({ // param
- merchant_uid: "ORD20180131-0000011", // Order ID
- m_redirect_url : "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
- popup : false // Always set to true in PC
- }, function (rsp) { // callback
- if (rsp.success) {
- ...,
- // When verification is successful,
- ...
- } else {
- ...,
- // When verification fails,
- ...
- }
- });
-```
-
-
+
+ ```ts title="client-side"
+ // Call IMP.certification(param, callback)
+ IMP.certification(
+ {
+ // param
+ merchant_uid: "ORD20180131-0000011", // Order ID
+ m_redirect_url: "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
+ popup: false, // Always set to true in PC
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful,
+ } else {
+ // When verification fails,
+ }
+ },
+ );
+ ```
+
diff --git a/src/content/docs/en/etc/all/send-verification-result.mdx b/src/content/docs/en/etc/all/send-verification-result.mdx
index a91e2264a..459bd3e3f 100644
--- a/src/content/docs/en/etc/all/send-verification-result.mdx
+++ b/src/content/docs/en/etc/all/send-verification-result.mdx
@@ -3,62 +3,70 @@ title: Send verification result
description: Process the result obtained from integrated identity verification.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
Based on the the verification result in the response object (**`rsp`**) returned after the verification process is completed, add the post-verification processing logic in the **`callback`** function. When the verification is successful, add the logic to **send the verification ID (`imp_uid`) to the server** as in the following example. Check the **value returned** when the verification is successful.
-### 1. Example of sending data via callback
+## 1. Example of sending data via callback
-
-```javascript title="client-side"
- IMP.certification({
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // When verification is successful
- // jQuery HTTP request
- jQuery.ajax({
- url: "{server-side endpoint to receive verification info}",
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert("Verification failed. Error: " + rsp.error_msg);
- }
- });Example of sending data via redirection
-```
-
-
+
+ ```ts title="client-side"
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // jQuery HTTP request
+ jQuery.ajax({
+ url: "{server-side endpoint to receive verification info}",
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert("Verification failed. Error: " + rsp.error_msg);
+ }
+ },
+ );
+ ```
+
-
-```javascript title="client-side"
-IMP.certification({
- /* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) { // When verification is successful
- // axios HTTP request
- axios({
- url: "{server-side endpoint to receive verification info}",
- method: "post",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert(\`Verification failed. Error: \${rsp.error_msg}\`);
- }
- });
-```
-
-
+
+ ```ts title="client-side"
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // axios HTTP request
+ axios({
+ url: "{server-side endpoint to receive verification info}",
+ method: "post",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert(`Verification failed. Error: ${rsp.error_msg}`);
+ }
+ },
+ );
+ ```
+
### 2. Example of sending data via redirection
-The page is redirected to the URL specified in `param.`**`m_redirect_url`** of `IMP.`**`certification`** with the verification data as follows:
+The page is redirected to the URL specified in `param.`**`m_redirect_url`**
+of `IMP.`**`certification`** with the verification data as follows:
-```uri title="Query String"
+```http title="Query String"
GET {m_redirect_url}?imp_uid={}&merchant_uid={merchant_uid for verification}&success={true or false}
```
-
diff --git a/src/content/docs/en/etc/budget.mdx b/src/content/docs/en/etc/budget.mdx
index e1cb65ca9..a76c09f52 100644
--- a/src/content/docs/en/etc/budget.mdx
+++ b/src/content/docs/en/etc/budget.mdx
@@ -3,4 +3,4 @@ title: Integrate budget handler
description: Learn how to integrate credit card promotion service.
---
-### Refer to the [**Budget handler guide**](http://localhost:5000/o/nad6nqI7LNE1TGdY19Od/s/zzqz39hKDV7YEtDAeA1v/).
+###Refer to the [**Budget handler guide**](http://localhost:5000/o/nad6nqI7LNE1TGdY19Od/s/zzqz39hKDV7YEtDAeA1v/).
diff --git a/src/content/docs/en/etc/credit-auth/1-prepare-for-verification.mdx b/src/content/docs/en/etc/credit-auth/1-prepare-for-verification.mdx
index dabba663c..08923e011 100644
--- a/src/content/docs/en/etc/credit-auth/1-prepare-for-verification.mdx
+++ b/src/content/docs/en/etc/credit-auth/1-prepare-for-verification.mdx
@@ -3,42 +3,37 @@ title: 1. Prepare for verification
description: Prepare for credit card verification integration.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### Add the **i'mport library** to the target page.
+## Add the **i'mport library** to the target page.
-Credit card identity verification is supported in **i'mport JavaScript v1.1.7 or later** versions.
-
+ Credit card identity verification is supported in **i'mport JavaScript v1.1.7 or later** versions.
-
-```html title="client-side"
-
-
-
-
-```
-
-
+
+ ```html title="client-side"
+
+
+
+
+ ```
+
-You **must install jQuery 1.0 or later version.**
-
+ You **must install jQuery 1.0 or later version.**
### Initialize the `IMP` object using the **`Merchant ID`** on the identity verification page.
-
-```javascript title="client-side"
-var IMP = window.IMP; // Can be omitted
-IMP.init("{Merchant ID}"); // Example: imp00000000
-```
-
-
+
+ ```ts title="client-side"
+ IMP.init("{Merchant ID}"); // Example: imp00000000
+ ```
+
diff --git a/src/content/docs/en/etc/credit-auth/2-request-verification.mdx b/src/content/docs/en/etc/credit-auth/2-request-verification.mdx
index 5147713a9..cdec51491 100644
--- a/src/content/docs/en/etc/credit-auth/2-request-verification.mdx
+++ b/src/content/docs/en/etc/credit-auth/2-request-verification.mdx
@@ -3,10 +3,10 @@ title: 2. Request verification
description: Call the credit card identity verification window.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### The credit card identity verification window can be invoked in the following two modes:
+## The credit card identity verification window can be invoked in the following two modes:
> **Popup** (Default)
>
@@ -28,47 +28,47 @@ The following example calls the JavaScript SDK
to open the credit card identity verification window.
-
-```javascript title="client-side"
-// Call IMP.certification(param, callback)
-IMP.certification({ // param
- merchant_uid: "ORD20180131-0000011", // Order ID
- m_redirect_url : "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
- popup : false // Always set to true in PC
- }, function (rsp) { // callback
- if (rsp.success) {
- ...,
- // When verification is successful,
- ...
- } else {
- ...,
- // When verification fails,
- ...
- }
- });
-```
-
-
-
-
-```javascript title="client-side"
- // Call IMP.certification(param, callback)
- IMP.certification({ // param
- merchant_uid: "ORD20180131-0000011", // Order ID
- m_redirect_url : "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
- popup : false // Always set to true in PC
- }, rsp => { // callback
- if (rsp.success) {
- ...,
- // When verification is successful,
- ...
- } else {
- ...,
- // When verification fails,
- ...
- }
- });
-```
+
+ ```ts title="client-side"
+ // Call IMP.certification(param, callback)
+ IMP.certification(
+ {
+ // param
+ merchant_uid: "ORD20180131-0000011", // Order ID
+ m_redirect_url: "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
+ popup: false, // Always set to true in PC
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful,
+ } else {
+ // When verification fails,
+ }
+ },
+ );
+ ```
+
-
+
+ ```ts title="client-side"
+ // Call IMP.certification(param, callback)
+ IMP.certification(
+ {
+ // param
+ merchant_uid: "ORD20180131-0000011", // Order ID
+ m_redirect_url: "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
+ popup: false, // Always set to true in PC
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // When verification is successful,
+ } else {
+ // When verification fails,
+ }
+ },
+ );
+ ```
+
diff --git a/src/content/docs/en/etc/credit-auth/3-send-verification-result.mdx b/src/content/docs/en/etc/credit-auth/3-send-verification-result.mdx
index 68f1fab82..05ff06e16 100644
--- a/src/content/docs/en/etc/credit-auth/3-send-verification-result.mdx
+++ b/src/content/docs/en/etc/credit-auth/3-send-verification-result.mdx
@@ -3,64 +3,75 @@ title: 3. Send verification result
description: Process the result obtained from credit card identity verification.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-Based on the the verification result in the response object ( **`rsp`** ) returned after the verification process is complete, add the post-verification processing logic in the **`callback`** function. When the verification is successful, add the logic to **send the verification ID (`imp_uid`) to the server** as in the following example. Check the **value returned** when the verification is successful.
+Based on the the verification result in the response object (**`rsp`**)
+returned after the verification process is complete,
+add the post-verification processing logic in the **`callback`** function.
+When the verification is successful, add the logic to **send the verification ID (`imp_uid`)
+to the server** as in the following example.
+Check the **value returned** when the verification is successful.
-### 1. Example of sending data via callback
+## 1. Example of sending data via callback
-
-```javascript
- IMP.certification({
- /* ...Omitted... */
- }, function (rsp) { // callback
- if (rsp.success) { // When verification is successful
- // jQuery HTTP request
- jQuery.ajax({
- url: "{server-side endpoint to receive verification info}",
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert("Verification failed. Error: " + rsp.error_msg);
- }
- });
-```
-
-
-
-
+
+ ```ts
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // jQuery HTTP request
+ jQuery.ajax({
+ url: "{server-side endpoint to receive verification info}",
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert("Verification failed. Error: " + rsp.error_msg);
+ }
+ },
+ );
+ ```
+
-```javascript title="client-side"
- IMP.certification({
- /* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) { // When verification is successful
- // axios HTTP request
- axios({
- url: "{server-side endpoint to receive verification info}",
- method: "post",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert(`Verification failed. Error: ${rsp.error_msg}`);
- }
- });
-
-```
-
-
+
+ ```ts title="client-side"
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // axios HTTP request
+ axios({
+ url: "{server-side endpoint to receive verification info}",
+ method: "post",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert(`Verification failed. Error: ${rsp.error_msg}`);
+ }
+ },
+ );
+ ```
+
-### 2. Example of sending data via redirection
+## 2. Example of sending data via redirection
-The page is redirected to the URL specified in `param.`**`m_redirect_url`** of `IMP.` **`certification`** with the verification data as follows:
+The page is redirected to the URL specified in `param.`**`m_redirect_url`**
+of `IMP.` **`certification`** with the verification data as follows:
-```uri title="Query String"
+```http title="Query String"
GET {m_redirect_url}?imp_uid={}&merchant_uid={merchant_uid for verification}&success
```
-
diff --git a/src/content/docs/en/etc/credit-auth/4-get-verification-info.mdx b/src/content/docs/en/etc/credit-auth/4-get-verification-info.mdx
index 05a8d93ec..5e7838589 100644
--- a/src/content/docs/en/etc/credit-auth/4-get-verification-info.mdx
+++ b/src/content/docs/en/etc/credit-auth/4-get-verification-info.mdx
@@ -5,79 +5,73 @@ description: >-
purposes.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
Use the **`imp_uid`** obtained through identity verification to get the customer's verification
information.
-### **STEP 01.** Get verification ID (imp_uid) on the server-side
+## **STEP 01.** Get verification ID (imp\_uid) on the server-side
The following server-side code fetches the data returned from identity verification.
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- // Get imp_uid from req.body
- const { imp_uid } = request.body;
-})
-```
-
-
-
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // controller that handles GET request to "/certifications/redirect"
- app.get("/certifications/redirect", async (request, response) => {
- const { imp_uid } = request.query; // Get imp_uid from req.query
-})
-```
-
-
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // controller that handles POST request to "/certifications"
+ app.post("/certifications", async (request, response) => {
+ // Get imp_uid from req.body
+ const { imp_uid } = request.body;
+ });
+ ```
+
+
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // controller that handles GET request to "/certifications/redirect"
+ app.get("/certifications/redirect", async (request, response) => {
+ const { imp_uid } = request.query; // Get imp_uid from req.query
+ });
+ ```
+
### **STEP 02.** Get verification information
To get verification information from the i'mport server, you must first get a [**REST API access token**](../../api/rest-api-access-token). Use the `access token` and `imp_uid` (verification ID) to call the **Get identity verification info REST API** that returns the verification information as follows:
-```javascript title="sever-side"
- app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
- data: {
- imp_key: "imp_apikey", // REST API Key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // Access token
- ...
- // Get verification info from i'mport server using imp_uid
- const getCertifications = await axios({
- url: \`https://api.iamport.kr/certifications/\${imp_uid}\`, // Pass imp_uid
- method: "get", // GET method
- headers: { "Authorization": access_token } // Add access token to Authorization header
- });
- const certificationsInfo = getCertifications.data.response; // Save verification info
- ...
- } catch(e) {
- console.error(e);
- }
- });
+```ts title="sever-side"
+app.use(bodyParser.json());
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
+ data: {
+ imp_key: "imp_apikey", // REST API Key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // Access token
+ // Get verification info from i'mport server using imp_uid
+ const getCertifications = await axios({
+ url: `https://api.iamport.kr/certifications/${imp_uid}`, // Pass imp_uid
+ method: "get", // GET method
+ headers: { Authorization: access_token }, // Add access token to Authorization header
+ });
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ } catch (e) {
+ console.error(e);
+ }
+});
```
### **STEP 03.** Using verification information
@@ -97,44 +91,43 @@ service logic.
- `unique_in_site`: same as DI value - unique key to identify the user per Merchant ID (website).
-**unique\_key and unique\_in\_site**
-
-Even if multiple credit cards are used to verify the same person, the same `unique_key` and `unique_in_site` values are returned for the cards under the same name.\
+ **unique\_key and unique\_in\_site**
+ Even if multiple credit cards are used to verify the same person,
+ the same `unique_key` and `unique_in_site` values are returned
+ for the cards under the same name.
-```javascript title="Node.js"
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- /* ...Omitted... */
- // Get verification info using imp_uid
- /* ...Omitted... */
- const certificationsInfo = getCertifications.data.response; // Save verification info
- // unique_key: Unique key for user, unique_in_site: Unique key for user per site
- const { unique_key, unique_in_site, name, gender, birth } = certificationsInfo;
- ...
- // Check age restrictions
- if (new Date(birth).getFullYear() <= 1999) {
- // Check successful
+```ts title="Node.js"
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ /* ...Omitted... */
+ // Get verification info using imp_uid
+ /* ...Omitted... */
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ // unique_key: Unique key for user, unique_in_site: Unique key for user per site
+ const { unique_key, unique_in_site, name, gender, birth } =
+ certificationsInfo;
+ // Check age restrictions
+ if (new Date(birth).getFullYear() <= 1999) {
+ // Check successful
+ } else {
+ // Check failed
+ }
+ // one account per person check
+ // Query database with unique_key to check for existing account
+ Users.find({ certificationKey: unique_key }).then((user) => {
+ if (!user) {
+ // New user
} else {
- // Check failed
+ // Existing user
}
- ...
- // one account per person check
- // Query database with unique_key to check for existing account
- Users.find({ certificationKey: unique_key })
- .then((user) => {
- if (!user) {
- // New user
- } else {
- // Existing user
- }
- });
- } catch(e) {
- console.error(e);
- }
- });
+ });
+ } catch (e) {
+ console.error(e);
+ }
+});
```
diff --git a/src/content/docs/en/etc/credit-auth/readme.mdx b/src/content/docs/en/etc/credit-auth/readme.mdx
index 7389f43fd..9c5f4de1c 100644
--- a/src/content/docs/en/etc/credit-auth/readme.mdx
+++ b/src/content/docs/en/etc/credit-auth/readme.mdx
@@ -7,7 +7,4 @@ import Figure from "~/components/Figure.astro";
The **credit card identity verification service** is used to confirm the accuracy of the identity information (name, date of birth, gender, foreigner status, and KISA ID) of the credit card holder.
-
+
diff --git a/src/content/docs/en/etc/native-mobile-sdks.mdx b/src/content/docs/en/etc/native-mobile-sdks.mdx
index 8458ad551..25f5ee210 100644
--- a/src/content/docs/en/etc/native-mobile-sdks.mdx
+++ b/src/content/docs/en/etc/native-mobile-sdks.mdx
@@ -3,14 +3,14 @@ title: Native mobile SDKs
description: You can integrate i'mport services through our native mobile SDKs (plugins).
---
-### Refer to the SDK GitHub link for your development platform.
+## Refer to the SDK GitHub link for your development platform.
-#### iOS/Android
+### iOS/Android
- [iOS](https://github.com/iamport/iamport-ios)
- [Android](https://github.com/iamport/iamport-android)
-#### Cross-Platform Frameworks
+### Cross-Platform Frameworks
- [Flutter](https://github.com/iamport/iamport-flutter)
- [Ionic](https://github.com/iamport/iamport-ionic)
diff --git a/src/content/docs/en/etc/phone/1-prepare-for-verification.mdx b/src/content/docs/en/etc/phone/1-prepare-for-verification.mdx
index 84815bc4f..fb26050de 100644
--- a/src/content/docs/en/etc/phone/1-prepare-for-verification.mdx
+++ b/src/content/docs/en/etc/phone/1-prepare-for-verification.mdx
@@ -3,25 +3,21 @@ title: 1. Prepare for verification
description: Prepare for mobile identity verification integration.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
Initialize the `IMP` object using the **`Merchant ID`**.
-
-```javascript title="client-side"
-var IMP = window.IMP; // Can be omitted
-IMP.init("{Merchant ID}"); // Example: imp00000000
-```
-
-
-
-
-```javascript title="client-side"
-const IMP = window.IMP; // Can be omitted
-IMP.init("{Merchant ID}"); // Example: imp00000000
-```
+
+ ```ts title="client-side"
+ IMP.init("{Merchant ID}"); // Example: imp00000000
+ ```
+
-
+
+ ```ts title="client-side"
+ IMP.init("{Merchant ID}"); // Example: imp00000000
+ ```
+
diff --git a/src/content/docs/en/etc/phone/2-request-verification.mdx b/src/content/docs/en/etc/phone/2-request-verification.mdx
index f8de42cd2..d855354e8 100644
--- a/src/content/docs/en/etc/phone/2-request-verification.mdx
+++ b/src/content/docs/en/etc/phone/2-request-verification.mdx
@@ -3,9 +3,9 @@ title: 2. Request verification
description: Call the mobile identity verification window.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
The mobile identity verification window can be invoked in the following two modes:
@@ -26,58 +26,58 @@ The mobile identity verification window can be invoked in the following two mode
> `false`.
-**Redirection mode**
-
-Redirection is supported in i'mport JavaScript **SDK 1.1.7** or later versions.
+ **Redirection mode**
+ Redirection is supported in i'mport JavaScript **SDK 1.1.7** or later versions.
The following example calls the mobile identity verification window.
-
-```javascript title="client-side"
- // Call IMP.certification(param, callback)
- IMP.certification({ // param
- merchant_uid: "ORD20180131-0000011", // Order ID
- m_redirect_url : "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
- popup : false // Always set to true in PC
- }, function (rsp) { // callback
- if (rsp.success) {
- ...,
- // When verification is successful,
- ...
- } else {
- ...,
- // When verification fails,
- ...
- }
- });
-```
-
-Check the [**parameters list**](../../sdk/javascript-sdk/identity-verification-request-parameters) for requesting the mobile identity verification window.
-
-
+
+ ```ts title="client-side"
+ // Call IMP.certification(param, callback)
+ IMP.certification(
+ {
+ // param
+ merchant_uid: "ORD20180131-0000011", // Order ID
+ m_redirect_url: "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
+ popup: false, // Always set to true in PC
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful,
+ } else {
+ // When verification fails,
+ }
+ },
+ );
+ ```
-
-```javascript title="client-side"
- // Call IMP.certification(param, callback)
- IMP.certification({ // param
- merchant_uid: "ORD20180131-0000011", // Order ID
- m_redirect_url : "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
- popup : false // Always set to true in PC
- }, rsp => { // callback
- if (rsp.success) {
- ...,
- // When verification is successful,
- ...
- } else {
- ...,
- // When verification fails,
- ...
- }
- });
-```
+ Check the [**parameters list**](../../sdk/javascript-sdk/identity-verification-request-parameters)
+ for requesting the mobile identity verification window.
+
-
+
+ ```ts title="client-side"
+ // Call IMP.certification(param, callback)
+ IMP.certification(
+ {
+ // param
+ merchant_uid: "ORD20180131-0000011", // Order ID
+ m_redirect_url: "{Redirect URL}", // Required when popup:false in mobile, Example: https://www.myservice.com/payments/complete/mobile
+ popup: false, // Always set to true in PC
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // When verification is successful,
+ } else {
+ // When verification fails,
+ }
+ },
+ );
+ ```
+
diff --git a/src/content/docs/en/etc/phone/3-send-verification-result.mdx b/src/content/docs/en/etc/phone/3-send-verification-result.mdx
index cf6431765..6401b6201 100644
--- a/src/content/docs/en/etc/phone/3-send-verification-result.mdx
+++ b/src/content/docs/en/etc/phone/3-send-verification-result.mdx
@@ -3,62 +3,75 @@ title: 3. Send verification result
description: Process the result obtained from mobile identity verification.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-Based on the the verification result in the response object (**`rsp`**) returned after the verification process is complete, add the post-verification processing logic in the **`callback`** function. When the verification is successful, add the logic to **send the verification ID (`imp_uid`) to the server** as in the following example. Check the **value returned** when the verification is successful. \
+Based on the the verification result in the response object (**`rsp`**)
+returned after the verification process is complete,
+add the post-verification processing logic in the **`callback`** function.
+When the verification is successful, add the logic to **send the verification ID (`imp_uid`)
+to the server** as in the following example.
+Check the **value returned** when the verification is successful.
-### 1. Example of sending data via callback
+## 1. Example of sending data via callback
-
-```javascript
-IMP.certification({
- /* ...Omitted... */
-}, function (rsp) { // callback
- if (rsp.success) { // When verification is successful
- // jQuery HTTP request
- jQuery.ajax({
- url: "{server-side endpoint to receive verification info}",
- method: "POST",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert("Verification failed. Error: " + rsp.error_msg);
- }
- });
-```
-
-
+
+ ```ts
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // jQuery HTTP request
+ jQuery.ajax({
+ url: "{server-side endpoint to receive verification info}",
+ method: "POST",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert("Verification failed. Error: " + rsp.error_msg);
+ }
+ },
+ );
+ ```
+
-
-```javascript title="client-side"
- IMP.certification({
- /* ...Omitted... */
- }, rsp => { // callback
- if (rsp.success) { // When verification is successful
- // axios HTTP request
- axios({
- url: "{server-side endpoint to receive verification info}",
- method: "post",
- headers: { "Content-Type": "application/json" },
- data: { imp_uid: rsp.imp_uid }
- });
- } else {
- alert(\`Verification failed. Error: \${rsp.error_msg}\`);
- }
- });
-```
-
-
+
+ ```ts title="client-side"
+ IMP.certification(
+ {
+ /* ...Omitted... */
+ },
+ (rsp) => {
+ // callback
+ if (rsp.success) {
+ // When verification is successful
+ // axios HTTP request
+ axios({
+ url: "{server-side endpoint to receive verification info}",
+ method: "post",
+ headers: { "Content-Type": "application/json" },
+ data: { imp_uid: rsp.imp_uid },
+ });
+ } else {
+ alert(`Verification failed. Error: ${rsp.error_msg}`);
+ }
+ },
+ );
+ ```
+
-### 2. Example of sending data via redirection
+## 2. Example of sending data via redirection
-The page is redirected to the URL specified in `param.`**`m_redirect_url`** of `IMP.`**`certification`** with the verification data as follows:
+The page is redirected to the URL specified in `param.`**`m_redirect_url`** of
+`IMP.`**`certification`** with the verification data as follows:
-```uri title="Query String"
+```http title="Query String"
GET {m_redirect_url}?imp_uid={}&merchant_uid={merchant_uid for verification}&success={true or false}
```
-
diff --git a/src/content/docs/en/etc/phone/4-get-verification-info.mdx b/src/content/docs/en/etc/phone/4-get-verification-info.mdx
index 77c91a1ba..92ef79b89 100644
--- a/src/content/docs/en/etc/phone/4-get-verification-info.mdx
+++ b/src/content/docs/en/etc/phone/4-get-verification-info.mdx
@@ -5,83 +5,75 @@ description: >-
purposes.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
Use the **`imp_uid`** obtained from mobile identity verification to get the customer's verification
information.
-### **STEP 01.** Get verification ID (imp_uid) on the server-side
+## **STEP 01.** Get verification ID (imp\_uid) on the server-side
The following server-side code fetches the data returned from mobile identity verification.
-
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from req.body
-})
-
-```
-
-
-
-
-```javascript
-app.use(bodyParser.json());
- ...
- // controller that handles GET request to "/certifications/redirect"
- app.get("/certifications/redirect", async (request, response) => {
- const { imp_uid } = request.query; // Get imp_uid from req.query
-})
-```
-
-
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // controller that handles POST request to "/certifications"
+ app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from req.body
+ });
+ ```
+
+
+
+ ```ts
+ app.use(bodyParser.json());
+ // controller that handles GET request to "/certifications/redirect"
+ app.get("/certifications/redirect", async (request, response) => {
+ const { imp_uid } = request.query; // Get imp_uid from req.query
+ });
+ ```
+
-### **STEP 02.** Get verification information
+## **STEP 02.** Get verification information
To get verification information from the i'mport server, you must first get a [**REST API access token**](../../api/rest-api-access-token). Use the `access token` and `imp_uid` (verification ID) to call the **Get identity verification info REST API** that returns the verification information as follows:
-```javascript title="sever-side"
+```ts title="sever-side"
app.use(bodyParser.json());
- ...
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- const getToken = await axios({
- url: "https://api.iamport.kr/users/getToken",
- method: "post", // POST method
- headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
- data: {
- imp_key: "imp_apikey", // REST API Key
- imp_secret: "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f" // REST API Secret
- }
- });
- const { access_token } = getToken.data.response; // Access token
- ...
- // Get verification info from i'mport server using imp_uid
- const getCertifications = await axios({
- url: `https://api.iamport.kr/certifications/\${imp_uid}\`, // Pass imp_uid
- method: "get", // GET method
- headers: { "Authorization": access_token } // Add access token to Authorization header
- });
- const certificationsInfo = getCertifications.data.response; // Save verification info
- ...
- } catch(e) {
- console.error(e);
- }
- });
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ const getToken = await axios({
+ url: "https://api.iamport.kr/users/getToken",
+ method: "post", // POST method
+ headers: { "Content-Type": "application/json" }, // "Content-Type": "application/json"
+ data: {
+ imp_key: "imp_apikey", // REST API Key
+ imp_secret:
+ "ekKoeW8RyKuT0zgaZsUtXXTLQ4AhPFW3ZGseDA6bkA5lamv9OqDMnxyeB9wqOsuO9W3Mx9YSJ4dTqJ3f", // REST API Secret
+ },
+ });
+ const { access_token } = getToken.data.response; // Access token
+ // Get verification info from i'mport server using imp_uid
+ const getCertifications = await axios({
+ url: `https://api.iamport.kr/certifications/${imp_uid}`, // Pass imp_uid
+ method: "get", // GET method
+ headers: { Authorization: access_token }, // Add access token to Authorization header
+ });
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ } catch (e) {
+ console.error(e);
+ }
+});
```
-### **STEP 03.** Using verification information
+## **STEP 03.** Using verification information
Retrieve the following user information from the verification information and add the necessary
service logic.
@@ -98,55 +90,52 @@ service logic.
- `unique_in_site`: same as DI value - unique key to identify the user per Merchant ID (website).
-In addition to the above information, if you need access to a user's mobile phone number (**`phone`**) and carrier (**`carrier`**) or foreigner status (**`foreigner`**), you must post a **Consent to Provision of Personal Information on your website** and send a **request to ****cs@iamport.kr**. Note that this service is available once it is requested to Danal PG and approved after contracting with i'mport.\
-
-**\**
+ In addition to the above information, if you need access to a user's mobile phone number (**`phone`**) and carrier (**`carrier`**) or foreigner status (**`foreigner`**), you must post a **Consent to Provision of Personal Information on your website** and send a **request to** **[cs@iamport.kr](mailto:cs@iamport.kr)**. Note that this service is available once it is requested to Danal PG and approved after contracting with i'mport.\\
-- Business name:
-- Business registration number:
-- Danal Merchant ID (CPID) for identity verification:
-- Privacy Policy URL: If unable to provide the URL when using an app service, capture and send the 'Privacy Policy' path.
+ **\**
-**\**
+ - Business name:
+ - Business registration number:
+ - Danal Merchant ID (CPID) for identity verification:
+ - Privacy Policy URL: If unable to provide the URL when using an app service, capture and send the 'Privacy Policy' path.
-- `Marpple Co., Ltd.: https://marpple.shop/kr/@/privacy`
-- `Brave Mobile Co., Ltd./Soomgo: https://soomgo.com/terms/privacy`
-- `Marketit Co., Ltd.: https://static.marketit.asia/static/privacy-terms.pdf`
+ **\**
+ - `Marpple Co., Ltd.: https://marpple.shop/kr/@/privacy`
+ - `Brave Mobile Co., Ltd./Soomgo: https://soomgo.com/terms/privacy`
+ - `Marketit Co., Ltd.: https://static.marketit.asia/static/privacy-terms.pdf`
-```javascript title="Node.js"
- // controller that handles POST request to "/certifications"
- app.post("/certifications", async (request, response) => {
- const { imp_uid } = request.body; // Get imp_uid from request.body
- try {
- // Get access token
- /* ...Omitted... */
- // Get verification info using imp_uid
- /* ...Omitted... */
- const certificationsInfo = getCertifications.data.response; // Save verification info
- // unique_key: Unique key for user, unique_in_site: Unique key for user per site
- const { unique_key, unique_in_site, name, gender, birth } = certificationsInfo;
- ...
- // Check age restrictions
- if (new Date(birth).getFullYear() <= 1999) {
- // Check successful
+```ts title="Node.js"
+// controller that handles POST request to "/certifications"
+app.post("/certifications", async (request, response) => {
+ const { imp_uid } = request.body; // Get imp_uid from request.body
+ try {
+ // Get access token
+ /* ...Omitted... */
+ // Get verification info using imp_uid
+ /* ...Omitted... */
+ const certificationsInfo = getCertifications.data.response; // Save verification info
+ // unique_key: Unique key for user, unique_in_site: Unique key for user per site
+ const { unique_key, unique_in_site, name, gender, birth } =
+ certificationsInfo;
+ // Check age restrictions
+ if (new Date(birth).getFullYear() <= 1999) {
+ // Check successful
+ } else {
+ // Check failed
+ }
+ // one account per person check
+ // Query database with unique_key to check for existing account
+ Users.find({ certificationKey: unique_key }).then((user) => {
+ if (!user) {
+ // New user
} else {
- // Check failed
+ // Existing user
}
- ...
- // one account per person check
- // Query database with unique_key to check for existing account
- Users.find({ certificationKey: unique_key })
- .then((user) => {
- if (!user) {
- // New user
- } else {
- // Existing user
- }
- });
- } catch(e) {
- console.error(e);
- }
- });
+ });
+ } catch (e) {
+ console.error(e);
+ }
+});
```
diff --git a/src/content/docs/en/etc/phone/readme.mdx b/src/content/docs/en/etc/phone/readme.mdx
index 803861e90..738649875 100644
--- a/src/content/docs/en/etc/phone/readme.mdx
+++ b/src/content/docs/en/etc/phone/readme.mdx
@@ -5,13 +5,18 @@ description: Learn how to integrate mobile identity verification service using i
import Figure from "~/components/Figure.astro";
-**Mobile phone identity verification service** is used to confirm the identity of the user and the accuracy of the user's identity information submitted through the mobile phone under the user's name.
+**Mobile phone identity verification service** is used to confirm
+the identity of the user and the accuracy of the user's identity information
+submitted through the mobile phone under the user's name.
-User's identity verification is needed to sign up for websites, make payments, or verify age. You can perform identity verification by using the identity verification app installed on a mobile device, or by submitting your identity information (**name, date of birth, mobile phone number**) through the verification request page and then confirming the verification number received via text message.
+User's identity verification is needed to sign up for websites, make payments, or verify age.
+You can perform identity verification by using the identity verification app
+installed on a mobile device, or by submitting your identity information
+(**name, date of birth, mobile phone number**) through the verification request page
+and then confirming the verification number received via text message.
-
+
-The flow of i'mport mobile identity verification involves performing verification using the JavaScript SDK and then the merchant server **retrieving the verification result** using the ChaiPort REST API.
+The flow of i'mport mobile identity verification involves performing verification
+using the JavaScript SDK and then the merchant server
+**retrieving the verification result** using the ChaiPort REST API.
diff --git a/src/content/docs/en/etc/url.mdx b/src/content/docs/en/etc/url.mdx
index 2d2ae58bf..02dddc9f6 100644
--- a/src/content/docs/en/etc/url.mdx
+++ b/src/content/docs/en/etc/url.mdx
@@ -4,19 +4,20 @@ description: Learn about the payment URL generation API.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Overview
+## 1. Overview
-This document describes i'mport payment URL generation API specification. i'mport Merchants can use the service without any restrictions.
+This document describes i'mport payment URL generation API specification.
+i'mport Merchants can use the service without any restrictions.
-### 2. API URI
+## 2. API URI
Payment API is exposed as REST web service.
@@ -25,230 +26,203 @@ Payment API is exposed as REST web service.
> **Content-Type : application/json;charset=UTF-8**
-
-
-```url title="URI"
-https://api.iamport-dev.co/api/supplements/v1/link/payment
-```
-
-
-
-
-
-```title="URI"
-https://api.iamport.co/api/supplements/v1/link/payment
-```
-
-
+
+ ```http title="URI"
+ POST https://api.iamport-dev.co/api/supplements/v1/link/payment
+ ```
+
+
+
+ ```http title="URI"
+ POST https://api.iamport.co/api/supplements/v1/link/payment
+ ```
+
-### 3. Description
+## 3. Description
-Customers can access the generated payment URL to make a payment. It supports all payment methods supported by the PG. When the link expires, payment is no longer available.
+Customers can access the generated payment URL to make a payment.
+It supports all payment methods supported by the PG.
+When the link expires, payment is no longer available.
-### 4. Request message specification
+## 4. Request message specification
-
-HTTP Method : POST
-
-Content-Type : Application.json;charset=UTF-8
-
-
-
-### Parameters
-
-#### Body
-
-
-
-
-Title of the bridge page
-
-
-
-
-
-
-
-Merchant ID
-
-
+
+ HTTP Method : POST
-
-
-
+ Content-Type : Application.json;charset=UTF-8
+
-Amount
+ ### Parameters
-
+ #### Body
-
-
-
+
+
+ Title of the bridge page
+
+
-Order ID
+
+
+ Merchant ID
+
+
-
+
+
+ Amount
+
+
-
-
-
+
+
+ Order ID
+
+
-Product name
+
+
+ Product name
+
+
-
+
+ Tax free amount
+
-
-
-Tax free amount
+
+
+ Currency code
+
+
-
-
-
+
+ Payment window language
-Currency code
+ -ko
-
+ -en
+
-
-
-Payment window language
+
+ Customer name
+
-\-ko
+
+
+ Customer phone
+
+
-\-en
+
+ Customer address
+
-
-
-Customer name
+
+ Customer email
+
-
-
-
+
+ Customer zip
+
-Customer phone
+
+ Custom data
+
-
+
+ Notification URL to receive payment result
+
-
-
-Customer address
+
+
+ Page expiration
+
+
-
-
-Customer email
+
+ Bridge page language
-
-
-Customer zip
+ -ko : Korean
-
-
-Custom data
+ -en : English
+
-
-
-Notification URL to receive payment result
+
+ **pg** **\*** **string**
-
-
-
+ PG code
-Page expiration
+ [#undefined](../sdk/javascript-sdk/rps#undefined "mention")
-
+ ---
-
-
-Bridge page language
+ **pay\_method** **\*** **string**
-\-ko : Korean
+ Payment method code
-\-en : English
+ [#undefined](../sdk/javascript-sdk/rps#undefined "mention")
-
-
-**pg** **\*** **string**
+ ---
-PG code
+ **label** **\*** **string**
-[#undefined](../sdk/javascript-sdk/rps#undefined "mention")
+ Payment method shown on bridge page
+
----
-
-**pay_method** **\*** **string**
-
-Payment method code
-
-[#undefined](../sdk/javascript-sdk/rps#undefined "mention")
-
----
-
-**label** **\*** **string**
-
-Payment method shown on bridge page
-
-
-
-### Responses
-
-
-```json title="json"
-{
- "shortenedUrl": "https://dev.impay.link/4bdf239e" //Create payment link
-}
-```
-
-
+ ### Responses
+
+ ```json title="json"
+ {
+ "shortenedUrl": "https://dev.impay.link/4bdf239e" //Create payment link
+ }
+ ```
+
**#Sample JSON request message**
-```title="json"
+```json title="json"
{
- "payment_info": "{\"title\":\"Test merchant\",\"user_code\":\"imp68124833\",\"amount\":10000,\"merchant_uid\":\"merchant_1630665784552\",\"name\":\"payment link test\",\"tax_free\":\"tax free amount\",\"currency\":\"KRW\",\"language\":\"ko\",\"buyer_name\":\"\",\"buyer_tel\":\"\",\"buyer_addr\":\"\",\"buyer_email\":\"\",\"buyer_postcode\":\"\",\"custom_data\":\"json_object\",\"notice_url\":\"notification url\",\"pay_methods\":[{\"pg\":\"INIpayTest\",\"pay_method\":\"card\",\"label\":\"credit/check card\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"naverpay\",\"label\":\"Naver Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"kakaopay\",\"label\":\"Kakao Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"phone\",\"label\":\"mobile micropayment\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"trans\",\"label\":\"account transfer\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"vbank\",\"label\":\"virtual account\"}]}",
- "expired_at": 1634324016
+ "payment_info": "{\"title\":\"Test merchant\",\"user_code\":\"imp68124833\",\"amount\":10000,\"merchant_uid\":\"merchant_1630665784552\",\"name\":\"payment link test\",\"tax_free\":\"tax free amount\",\"currency\":\"KRW\",\"language\":\"ko\",\"buyer_name\":\"\",\"buyer_tel\":\"\",\"buyer_addr\":\"\",\"buyer_email\":\"\",\"buyer_postcode\":\"\",\"custom_data\":\"json_object\",\"notice_url\":\"notification url\",\"pay_methods\":[{\"pg\":\"INIpayTest\",\"pay_method\":\"card\",\"label\":\"credit/check card\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"naverpay\",\"label\":\"Naver Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"kakaopay\",\"label\":\"Kakao Pay\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"phone\",\"label\":\"mobile micropayment\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"trans\",\"label\":\"account transfer\"},{\"pg\":\"INIpayTest\",\"pay_method\":\"vbank\",\"label\":\"virtual account\"}]}",
+ "expired_at": 1634324016
}
```
**#Sample payment (bridge) page**
-
-**Sample response URL page displayed when payment URL API request is successful.**
-
-
-
-
+
+ **Sample response URL page displayed when payment URL API request is successful.**
-
-**Sample page displayed for an expired payment URL page (expire\_at exceeded).**
+
+
-
+
+ **Sample page displayed for an expired payment URL page (expire\_at exceeded).**
-
+
+
-### 5. Disabling payment URL
+## 5. Disabling payment URL
-**Append the last part of the response** (**shortenedUrl**) **URL to the payment URI API address and call it.**
+**Append the last part of the response** (**shortenedUrl**)
+**URL to the payment URI API address and call it.**
> **HTTP Method :** **PUT**
-**For the following API response**
-
-```json
-{ "shortenedUrl": "https://dev.impay.link/4bdf239e" }
-```
+ **For the following API response**
-[https://api.iamport.co/api/supplements/v1/link/payment/](https://api.iamport.co/api/supplements/v1/link/payment/%7BGUID%7D) **4bdf239e**
+ ```json
+ { "shortenedUrl": "https://dev.impay.link/4bdf239e" }
+ ```
-Call the above payment URL to disable it.
+ [https://api.iamport.co/api/supplements/v1/link/payment/](https://api.iamport.co/api/supplements/v1/link/payment/%7BGUID%7D) **4bdf239e**
+ Call the above payment URL to disable it.
diff --git a/src/content/docs/en/faq/undefined.mdx b/src/content/docs/en/faq/undefined.mdx
index 888aa616e..2235bba15 100644
--- a/src/content/docs/en/faq/undefined.mdx
+++ b/src/content/docs/en/faq/undefined.mdx
@@ -7,50 +7,50 @@ import Details from "~/components/gitbook/Details.astro";
import Hint from "~/components/Hint.astro";
-
Webhook call rules
+
Webhook call rules
-- Webhook is only sent once by default.
-- You can set to resend (retry) the webhook up to 5 times in 1 minute increments. i'mport will stop sending the webhook once the merchant responds with HTTP STATUS 200.
-- You can also manually resend the webhook from the Admin console. (Payment approvals -> Webhook log -> Resend)
-- If you change the webhook address, webhooks for past transactions are sent to the previous webhook URL.
+ - Webhook is only sent once by default.
+ - You can set to resend (retry) the webhook up to 5 times in 1 minute increments.
+ i'mport will stop sending the webhook once the merchant responds with HTTP STATUS 200.
+
+ - You can also manually resend the webhook from the Admin console. (Payment approvals -> Webhook log -> Resend)
+
+ - If you change the webhook address, webhooks for past transactions are sent to the previous webhook URL.
-
Provision of comprehensive response code list
-
-The error code and message in the payment response are the same as those sent by the source (PG). There is no comprehensive error code list because the response codes and messages differ by each PG linked with i'mport.
+
Provision of comprehensive response code list
+ The error code and message in the payment response are the same as those sent by the source (PG).
+ There is no comprehensive error code list because the response codes and messages differ by each PG linked with i'mport.
-
How to distinguish between production account and developer account
+
How to distinguish between production account and developer account
-### **Single account for both production and test modes**
+ ## **Single account for both production and test modes**
-Enter the merchant information for testing by clicking 'Add PG' from existing settings.
+ Enter the merchant information for testing by clicking 'Add PG' from existing settings.
-- Pros: Can use the same Merchant ID and API key/secret for testing.
-- Cons: Care needs to be taken in setting/saving PGs because the settings are shared with the production account.
+ - Pros: Can use the same Merchant ID and API key/secret for testing.
+ - Cons: Care needs to be taken in setting/saving PGs because the settings are shared with the production account.
-**\[Checklist]**
+ **\[Checklist]**
-To request payment with a specific Merchant ID for the same PG, you must specify the `pg` parameter as **PG. Merchant ID**.
+ To request payment with a specific Merchant ID for the same PG,
+ you must specify the `pg` parameter as **PG. Merchant ID**.
-### **Create a separate test-only account**
+ ### **Create a separate test-only account**
-You can create a developer account by signing up in the i'mport Admin page ([https://admin.iamport.kr/](https://admin.iamport.kr/)).
-
-- Pros: Enables stable testing by using separate accounts for production and development.
-- Cons: Requires source code branching due to having different Merchant ID and API key/secret for each account.
+ You can create a developer account by signing up in the i'mport Admin page ([https://admin.iamport.kr/](https://admin.iamport.kr/)).
+ - Pros: Enables stable testing by using separate accounts for production and development.
+ - Cons: Requires source code branching due to having different Merchant ID and API key/secret for each account.
-**For additional FAQs, refer to:**
-
-[https://faq.iamport.kr/](https://faq.iamport.kr/)
+ **For additional FAQs, refer to:**
+ [https://faq.iamport.kr/](https://faq.iamport.kr/)
-
-
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/blue-walnut.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/blue-walnut.mdx
index 4556ac1e0..dfbd0f08a 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/blue-walnut.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/blue-walnut.mdx
@@ -5,88 +5,86 @@ description: Blue Walnut payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### 1. Configure Blue Walnut PG settings
+## 1. Configure Blue Walnut PG settings
-Refer to the [**Blue Walnut settings**](../../ready/2.-pg/payment-gateway-settings/undefined-7) page to configure the PG settings.
+Refer to the [**Blue Walnut settings**](../../ready/2.-pg/payment-gateway-settings/undefined-7)
+page to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'bluewalnut',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- buyer_email : 'iamport@siot.do', // required
- buyer_name : 'Jack Son', // Must include a space between Firstname Lastname
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-###
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "bluewalnut",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do", // required
+ buyer_name: "Jack Son", // Must include a space between Firstname Lastname
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`bluewalnut`**.
+ ### Key parameter description
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ **`pg`** **\*** **string**
-**Payment method code**
+ **PG code**
-
-
Payment method codes
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`bluewalnut`**.
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `phone`(mobile micropayment)
+ **`pay_method`** **\*** **string**
-
+ **Payment method code**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+
+
Payment method codes
-**Order ID**
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+
-Must be unique for each request.
+ **`merchant_uid`** **\*** **string**
-**`amount`** **\***\*\* ****integer\*\*
+ **Order ID**
-**Payment amount**
+ Must be unique for each request.
-Must be an integer (not string)
+ **`amount`** **\*** **integer**
-
+ **Payment amount**
-
+ Must be an integer (not string)
-
-#### Not supported
+
+
-
+
+ Not supported
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/danal.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/danal.mdx
index 0a8f1c2bc..1fe8c2857 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/danal.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/danal.mdx
@@ -5,256 +5,254 @@ description: Danal payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Danal PG settings
+## 1. Configure Danal PG settings
-Refer to the [**Danal settings**](../../ready/2.-pg/payment-gateway-settings/undefined-2) page to configure the PG settings.
+Refer to the [**Danal settings**](../../ready/2.-pg/payment-gateway-settings/undefined-2) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the Danal TPay payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the Danal TPay payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
In both PC and mobile browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "danal_tpay",
- pay_method: "card",
- merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
- name: "Order name: Test payment request",
- amount: 14000,
- buyer_email: "iamport@siot.do",
- buyer_name: "John Doe",
- buyer_tel: "010-1234-5678",
- buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "danal_tpay",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-### Key parameter description
+ ### Key parameter description
-**`pg`** **\*** **s** **tring**
+ **`pg`** **\*** **string**
-**PG code**
+ **PG code**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`danal_tpay`**.
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`danal_tpay`**.
-**`pay_method`** **\*** **s** **tring**
+ **`pay_method`** **\*** **string**
-**Payment method code**
+ **Payment method code**
-
-
Payment method codes
+
+
Payment method codes
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `cultureland`(Cultureland)
-- `happymoney`(Happy Money)
-- `booknlife` (Book n culture gift card)
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `cultureland`(Cultureland)
+ - `happymoney`(Happy Money)
+ - `booknlife` (Book n culture gift card)
+
-
+ **`merchant_uid`** **\*** **string**
-**`merchant_uid`** **\*** **s** **tring**
+ **Order ID**
-**Order ID**
+ Must be unique for each request.
-Must be unique for each request.
+ **`buyer_tel`** **\*** **`string`**
-**`buyer_tel`** **`*`** **`string`**
+ **Customer phone number**
-**Customer phone number**
+ Danal payment window may throw an error if omitted
-Danal payment window may throw an error if omitted
+ **`amount`** **\*** **integer**
-**`amount`** **\*** **integer**
+ **Payment amount**
-**Payment amount**
+ Must be an integer (not string)
-Must be an integer (not string)
+
+ #### Virtual account payment requirement
-
-#### Virtual account payment requirement
+ - **`biz_num`**: 10-digit business registration number (required)
+
-- **`biz_num`**: 10-digit business registration number (required)
+
+
-
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter.
-
-
+
+ #### **amount**
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter.
+ - If requesting **both billing key and initial payment**, specify the payment amount.
-
-#### **amount**
-
-- If requesting **both billing key and initial payment**, specify the payment amount.
-- If only requesting for billing key, set to **0**.\
- (if amount is set to 0, Danal executes a test payment of 10 won which is automatically cancelled after 30 minutes.)
-
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "danal_tpay",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Order name: Billing key request test",
- amount: 0, // For display purpose only (set actual amount to also request payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
- period: {
- from: "20200101", //YYYYMMDD
- to: "20201231", //YYYYMMDD
- },
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
+ - If only requesting for billing key, set to **0**.\
+ (if amount is set to 0, Danal executes a test payment of 10 won which is automatically cancelled after 30 minutes.)
+
-### Key parameter description
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "danal_tpay",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Order name: Billing key request test",
+ amount: 0, // For display purpose only (set actual amount to also request payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ period: {
+ from: "20200101", //YYYYMMDD
+ to: "20201231", //YYYYMMDD
+ },
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-**`pg`** **\***\*\* ****s****tring\*\*
+ ### Key parameter description
-**PG code**
+ **`pg`** **\*** **string**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`danal_tpay`**.
+ **PG code**
-**`customer_uid`** **\*** **string**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`danal_tpay`**.
-**Credit card billing key**
+ **`customer_uid`** **\*** **string**
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **Credit card billing key**
-**`amount`** **\*** **Integer**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-**Payment amount**
+ **`amount`** **\*** **Integer**
-0: only billing key, **> 0: billing key + initial payment**
+ **Payment amount**
-**` period`` `****`array`**
+ 0: only billing key, **> 0: billing key + initial payment**
-Product subscription payment for subscription payment. The date is displayed on the Danal payment window.
+ **`period`` `****`array`**
-**`from`****`: YYYYMMDD`**
+ Product subscription payment for subscription payment. The date is displayed on the Danal payment window.
-**`to`****`: YYYYMMDD`**\
+ **`from`****`: YYYYMMDD`**
-### Request payment with billing key (customer_uid)
+ **`to`****`: YYYYMMDD`**\\
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ ### Request payment with billing key (customer\_uid)
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ After successfully getting the billing key,
+ the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-### 3. Additional functions
+## 3. Additional functions
-
-```javascript title="javascript"
-display: {
- card_quota: [6] // Display up to 6 months installment plans
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - `[]`: Only immediate pay
- - `3,6`: immediate, 3, 6 month installment plans
-
-
-Installment plan option is available only for **KRW 50,000 or more**.
-
-
-
-
-
-
-
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3,
- usePoint : “Y”
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6] // Display up to 6 months installment plans
+ }
}
-}
-```
-
-**Parameters**
-
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
-- **usePoint**: Option to use points (post applied)
-
-
-**Danal setup required**
-
-- Direct module call requires pre-setup by Danal.
-
-
-
-
-
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
+ ```
+
+ **Parameters**
+
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `3,6`: immediate, 3, 6 month installment plans
+
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
+
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3,
+ "usePoint": "Y"
+ }
+ }
+ }
+ ```
+
+ **Parameters**
+
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
+ - **usePoint**: Option to use points (post applied)
+
+
+ **Danal setup required**
+
+ - Direct module call requires pre-setup by Danal.
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
-**Parameters**
+ **Parameters**
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630)
+ (**string)**
-
+ - **enabled:** Option to enable the credit card (**boolean)**
-
+
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/precautions-for-using-payjoa.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/precautions-for-using-payjoa.mdx
index be0c7aaf4..9a147afee 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/precautions-for-using-payjoa.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/precautions-for-using-payjoa.mdx
@@ -8,171 +8,169 @@ import Details from "~/components/gitbook/Details.astro";
## Things to note when integrating PAYJOA
-
Returns success in PC and imp_success in mobile
-
-The payment window call (`IMP.request_pay`) and post-payment processing differs for PC and mobile. In PC, the call is made using iframe and the callback function (the second argument of IMP.request_pay) is called after the payment process is completed. In mobile, the page is redirected (302) to the specified URL (`m_redirect_url`_)._ At this time, the payment result (success/failure) is returned using the `success` parameter for PC and `imp_success` parameter for mobile. To summarize the flow:
-
-- \[PC] iframe → callback → result delivered in response.`success` returned via callback
-
- ```jsx
- IMP.request_pay(
- {
- // Omitted
- },
- function (response) {
- const { success } = response; // payment successul or failed
- if (success) {
- // Success logic
- } else {
- // Failure logic
- }
- }
- );
- ```
-
-- \[Mobile] Redirect → redirct (302) to m_redirect_url → result delivered in `imp_success` query parameter
-
- ```jsx
- /**
- * Sample 302 redirect URL redirected to after payment process is completed
- * when m_redirect_url is set to 'https://myservice.com/payments/complete'
- */
- https://myservice.com/payments/complete?**imp_success=true**&imp_uid=imp1234567890&merchant_uid=mid_123467890
- ```
-
-#### **`imp_success` and `success` are deprecated**
-
-Regardless you should not determine the success/failure of a payment based on either of these parameters. It only indicates the failure/success of payment at the time of the response from i'mport → merchant client, and its value can only be finalized when notification of the result is sent from PAYJOA → i'mport and then it is updated in the i'mport DB.
-
-Since the **payment result is sent asynchronously in \[PAYJOA → i'mport → i'mport DB update] and \[i'mport → merchant client]**, **the `imp_success` or `success` parameter received by the merchant client can be false (failed) for a successful transaction if it has not been updated in the database yet**.
-
-Hence, only the i'mport order ID (`imp_uid`) and the merchant order ID (`merchant_uid`) of the result are accurate. You must send these values to the merchant server and use them to call the i'mport Get payment API ([GET /payments/\{imp_uid}](https://api.iamport.kr/#!/payments/getPaymentByImpUid)) to accurately determine whether the payment is successful (`status`=`paid`) or failed (`status`=`failed`).
-
+
Returns success in PC and imp\_success in mobile
+
+ The payment window call (`IMP.request_pay`) and post-payment processing differs for PC and mobile.
+ In PC, the call is made using iframe and the callback function
+ (the second argument of IMP.request\_pay) is called after the payment process is completed.
+ In mobile, the page is redirected (302) to the specified URL (`m_redirect_url`).
+ At this time, the payment result (success/failure) is returned using the `success` parameter for PC
+ and `imp_success` parameter for mobile. To summarize the flow:
+
+ - \[PC] iframe → callback → result delivered in response.`success` returned via callback
+
+ ```tsx
+ IMP.request_pay(
+ {
+ // Omitted
+ },
+ function (response) {
+ const { success } = response; // payment successul or failed
+ if (success) {
+ // Success logic
+ } else {
+ // Failure logic
+ }
+ },
+ );
+ ```
+
+ - \[Mobile] Redirect → redirct (302) to m\_redirect\_url → result delivered in `imp_success` query parameter
+
+ ```js
+ /**
+ * Sample 302 redirect URL redirected to after payment process is completed
+ * when m_redirect_url is set to 'https://myservice.com/payments/complete'
+ */
+ "https://myservice.com/payments/complete?imp_success=true&imp_uid=imp1234567890&merchant_uid=mid_123467890";
+ ```
+
+ ### **`imp_success` and `success` are deprecated**
+
+ Regardless you should not determine the success/failure of a payment based on either of these parameters.
+ It only indicates the failure/success of payment at the time of the response from i'mport → merchant client,
+ and its value can only be finalized when notification of the result is sent from PAYJOA → i'mport
+ and then it is updated in the i'mport DB.
+
+ Since the **payment result is sent asynchronously in \[PAYJOA → i'mport → i'mport DB update]
+ and \[i'mport → merchant client]**, **the `imp_success` or `success` parameter received
+ by the merchant client can be false (failed) for a successful transaction
+ if it has not been updated in the database yet**.
+
+ Hence, only the i'mport order ID (`imp_uid`) and the merchant order ID
+ (`merchant_uid`) of the result are accurate.
+ You must send these values to the merchant server and use them
+ to call the i'mport Get payment API ([GET /payments/\{imp\_uid}](https://api.iamport.kr/#!/payments/getPaymentByImpUid))
+ to accurately determine whether the payment is successful (`status`=`paid`) or failed (`status`=`failed`).
-
Session related issues when paying with Hana card/NH Apps Cache in Safari
-
-When paying with Hana card/NH Apps Cache (account transfer) in Safari, the message below (the session has expired and the connection with the card company has been terminated) is displayed and payment cannot be processed.
+
Session related issues when paying with Hana card/NH Apps Cache in Safari
-
+ When paying with Hana card/NH Apps Cache (account transfer) in Safari,
+ the message below (the session has expired and the connection with the card company has been terminated)
+ is displayed and payment cannot be processed.
-If you are experiencing this, make sure that the `Prevent cross-site tracking` and `Block all cookies` options are not checked in Safari Preferences as shown below, and then try again.
+
-
+ If you are experiencing this, make sure that the `Prevent cross-site tracking` and `Block all cookies` options
+ are not checked in Safari Preferences as shown below, and then try again.
+
-
Issues when paying with BC card in Safari/Firefox
-
-If you click the Next button after selecting BC Card in the credit card payment window, “Payment failed” alert message is displayed and you cannot proceed any further. In other browsers (Chrome, Opera, Edge, etc.) or when using other credit cards, the Facebook QR code for BC card payment is rendered without any problem.
+
Issues when paying with BC card in Safari/Firefox
-
+ If you click the Next button after selecting BC Card in the credit card payment window,
+ “Payment failed” alert message is displayed and you cannot proceed any further.
+ In other browsers (Chrome, Opera, Edge, etc.) or when using other credit cards,
+ the Facebook QR code for BC card payment is rendered without any problem.
-If you are experiencing this, make sure that pop-ups are allowed for the `*.payjoa.co.kr` domain in Safari Preferences as shown below, and then try again.
+
-
+ If you are experiencing this, make sure that pop-ups are allowed for the `*.payjoa.co.kr` domain
+ in Safari Preferences as shown below, and then try again.
+
-
Instant account transfer payment flow difference
+
Instant account transfer payment flow difference
-Since PAYJOA internally uses Toss Payments - account transfer, account transfer is available only through Toss Simple Payment, NH Apps Cache, and direct input of account information. Entering account information directly requires security card/OTP authentication → public certificate authentication.
+ Since PAYJOA internally uses Toss Payments - account transfer, account transfer is available
+ only through Toss Simple Payment, NH Apps Cache, and direct input of account information.
+ Entering account information directly requires security card/OTP authentication → public certificate authentication.
-For mobile payment, account transfer payment is available only through Toss Simple Payment and NH Apps Cache.
+ For mobile payment, account transfer payment is available only through Toss Simple Payment and NH Apps Cache.
-
-
-
+
+
-
Only depositor's name can be accessed after virtual account deposit
-
-When deposit is made to the (issued) virtual account, PAYJOA only reveals the name among the depositor's information (bank name, account number, sender). Therefore, when you retrieve the i'mport payment details ([**GET /payments/\{imp_uid}**](../../../api/payment-api/get-payment-api)), the depositor's bank code (`bank_code`) and bank name (`bank_name`) are both NULL. To get the depositor's name, you must set the query parameter (`extension`) to `true` as follows:
-
-```jsx
-GET http://api.iamport.kr/payments/{i'mport number}?extension=true
-
-{
- // ... Omitted
- bank_code: null, // Depositor's bank code not provided
- bank_name: null, // Depositor's bank name not provided
- extension: {
- // ... Omitted
- **"REMITTER": "John Doe" // Depositor's name**
- }
-}
-```
-
+
Only depositor's name can be accessed after virtual account deposit
+
+ When deposit is made to the (issued) virtual account,
+ PAYJOA only reveals the name among the depositor's information (bank name, account number, sender).
+ Therefore, when you retrieve the i'mport payment details ([**GET /payments/\{imp\_uid}**](../../../api/payment-api/get-payment-api)),
+ the depositor's bank code (`bank_code`) and bank name (`bank_name`) are both NULL.
+ To get the depositor's name, you must set the query parameter (`extension`) to `true` as follows:
+
+ ```json
+ // GET http://api.iamport.kr/payments/{i'mport number}?extension=true
+ {
+ // ... Omitted
+ "bank_code": null, // Depositor's bank code not provided
+ "bank_name": null, // Depositor's bank name not provided
+ "extension": {
+ // ... Omitted
+ "REMITTER": "John Doe" // Depositor's name
+ }
+ }
+ ```
-
Special contract with PAYJOA is required to cancel virtual account payment
-
-Cancellation (refund) of payment for completed virtual account deposit is available only through a special contract with PAYJOA due to virtual account issuance fee issues. Refunds for virtual account payments cannot be processed without this contract.
+
Special contract with PAYJOA is required to cancel virtual account payment
+ Cancellation (refund) of payment for completed virtual account deposit is available
+ only through a special contract with PAYJOA due to virtual account issuance fee issues.
+ Refunds for virtual account payments cannot be processed without this contract.
-
Cancellation of virtual account payment takes more than 7 business days to process
-
-Cancellation (refund) of PAYJOA virtual account payment is requested from the merchant → i'mport → PAYJOA. Since the refund is processed after a PAYJOA staff manually checks the request, it takes more than 7 business days for the refund amount to be deposited.
+
Cancellation of virtual account payment takes more than 7 business days to process
+ Cancellation (refund) of PAYJOA virtual account payment is requested from the merchant → i'mport → PAYJOA.
+ Since the refund is processed after a PAYJOA staff manually checks the request,
+ it takes more than 7 business days for the refund amount to be deposited.
-
Only one taxable/tax-free/combination CPID is issued for each case
-
-You need to request PAYJOA to issue the CPID on a `case-by-case` basis. In this way, all taxable/tax-free/combination transactions can be processed with one CPID.
+
Only one taxable/tax-free/combination CPID is issued for each case
+ You need to request PAYJOA to issue the CPID on a `case-by-case` basis.
+ In this way, all taxable/tax-free/combination transactions can be processed with one CPID.
-
Tax-free amount can be set only for card payment
-
-When calling the payment window (IMP.request_pay function), you can set the tax-free amount (`tax_free`) out of the total amount (`amount`). In the PAYJOA system, the tax-free amount is only available when paying by card (pay_method: `card`). Account transfer and virtual account payments are taxed in full.
+
Tax-free amount can be set only for card payment
+ When calling the payment window (IMP.request\_pay function),
+ you can set the tax-free amount (`tax_free`) out of the total amount (`amount`).
+ In the PAYJOA system, the tax-free amount is only available when paying by card (pay\_method: `card`).
+ Account transfer and virtual account payments are taxed in full.
-
PAYJOA bug
-
-#### Customer's phone number is not automatically filled in the escrow payment window
+
PAYJOA bug
-
+ ### Customer's phone number is not automatically filled in the escrow payment window
-- Unlike other payment windows, the customer's phone number (`buyer_tel`) passed into IMP.request_pay is not automatically filled in the escrow payment window. Note that PAYJOA does not support this function.
+
+ - Unlike other payment windows, the customer's phone number (`buyer_tel`) passed into IMP.request\_pay
+ is not automatically filled in the escrow payment window. Note that PAYJOA does not support this function.
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/readme.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/readme.mdx
index 9ecbf5181..e54c964d4 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/readme.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/daou-payjoa/readme.mdx
@@ -5,232 +5,232 @@ description: Daou payment window integration guide
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Daou PG settings
+## 1. Configure Daou PG settings
Refer to the [**Daou settings**](../../../ready/2.-pg/payment-gateway-settings/daou) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-**PAYJOA payment window integration requires ****JS SDK 1.2.0**** or later version.**
-
+ **PAYJOA payment window integration requires ****JS SDK 1.2.0**** or later version.**
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'daou',
- pay_method : 'card',
- merchant_uid: 'mid_1234567890',
- escrow: false,
- amount: 1004,
- name: 'NF long padding jacket M',
- buyer_name: 'John Doe',
- buyer_email: 'hello@world.com',
- buyer_tel: '01012345678',
- digital : false, // Set to true if contracted as digital
- m_redirect_url: 'https://allerts.com/payments/complete',
- bypass: {
- // PAYJOA (DaouData) specific parameters
- daou: {
- PRODUCTCODE: 'iamport',
- CASHRECEIPTFLAG: 2,
- },
- },
- app_scheme: 'iamportappscheme',
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-###
-
-### Key parameter description
-
-**`pg`** **\*** **s** **tring**
-
-**PG code**
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "daou",
+ pay_method: "card",
+ merchant_uid: "mid_1234567890",
+ escrow: false,
+ amount: 1004,
+ name: "NF long padding jacket M",
+ buyer_name: "John Doe",
+ buyer_email: "hello@world.com",
+ buyer_tel: "01012345678",
+ digital: false, // Set to true if contracted as digital
+ m_redirect_url: "https://allerts.com/payments/complete",
+ bypass: {
+ // PAYJOA (DaouData) specific parameters
+ daou: {
+ PRODUCTCODE: "iamport",
+ CASHRECEIPTFLAG: 2,
+ },
+ },
+ app_scheme: "iamportappscheme",
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`daou`**.
+ ### Key parameter description
-**`pay_method`** **\*** **s** **tring**
+ **`pg`** **\*** **string**
-**Payment method code**
+ **PG code**
-
-
Payment method codes
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`daou`**.
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
+ **`pay_method`** **\*** **string**
-
+ **Payment method code**
-**`merchant_uid`** **\*** **s** **tring**
+
+
Payment method codes
-**Order ID**
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+
-Must be unique for each request.
+ **`merchant_uid`** **\*** **string**
-**`digital`** **`*`** **`string`**
+ **Order ID**
-**Digital contents option**
+ Must be unique for each request.
-Must specify the value based on the contract between merchant and PAYJOA. Otherwise, request will fail.
+ **`digital`** **`*`** **`string`**
-**`bypass.daou.PRODUCTCODE`** **`string`**
+ **Digital contents option**
-**Product code**
+ Must specify the value based on the contract between merchant and PAYJOA. Otherwise, request will fail.
-If there is no specification for the value and the value is not specified, i'mport sets it to the default value (iamport) and sends it to PAYJOA.
+ **`bypass.daou.PRODUCTCODE`** **`string`**
-**`bypass.daou.CASHRECEIPTFLAG`** **``** **`integer`**
+ **Product code**
-**Cash receipt issuance code**
+ If there is no specification for the value and the value is not specified, i'mport sets it to the default value (iamport) and sends it to PAYJOA.
-Auto cash receipt issuance code for cash payments (account transfer, virtual account)
+ **`bypass.daou.CASHRECEIPTFLAG`** **\`\`** **`integer`**
-**`1: Allow`**
+ **Cash receipt issuance code**
-**`2: Block`**
+ Auto cash receipt issuance code for cash payments (account transfer, virtual account)
-**`app_scheme`** **`string`**
+ **`1: Allow`**
-**Mobile app URL scheme**
+ **`2: Block`**
-Required in mobile app
+ **`app_scheme`** **`string`**
-**`amount`** **\*** **integer**
+ **Mobile app URL scheme**
-**Payment amount**
+ Required in mobile app
-Must be an integer (not string)
+ **`amount`** **\*** **integer**
-**`escrow`** **`boolean`**
+ **Payment amount**
-**Escrow option**
+ Must be an integer (not string)
-Only supports account transfer and virtual account payment.
+ **`escrow`** **`boolean`**
-
+ **Escrow option**
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ Only supports account transfer and virtual account payment.
+
-### Request one-time payment
+
+ **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+ ### Request one-time payment
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ To request a one-time payment, use the key-in REST[**API POST /subscribe/payments/onetime**](../../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-###
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-### Request billing key
+ ### Request billing key
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../../api/billing-key-api/api-1).
+ To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer\_uid}**](../../../api/billing-key-api/api-1).
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-### Request billing key + initial payment
+ ### Request billing key + initial payment
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../../api/api/request-non-authenticated-payment-one-time-api).
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../../api/api/request-non-authenticated-payment-one-time-api).
-- **`customer_uid`** : required for saving the billing key.
+ - **`customer_uid`** : required for saving the billing key.
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-### Request payment with billing key
+ ### Request payment with billing key
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../../api/api/api)) with the `customer_uid` as follows:
+ After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../../api/api/api)) with the `customer_uid` as follows:
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-**For detailed information, refer to:**
+ **For detailed information, refer to:**
-
-
-
+
+
-### 3. Additional functions
+## 3. Additional functions
-
-```javascript title="javascript"
-display: {
- card_quota: [6] // Display up to 6 months installment plans
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6], // Display up to 6 months installment plans
+ }
+ }
+ ```
-
-Installment plan option is available only for **KRW 50,000 or more**.
+ **Parameters**
-
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\\
-
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
+
-
-For escrow payment, the **`escrow`** parameter must be set to **true** . When the escrow payment is completed, the merchant must register the shipping information for **settlement**. You can manage shipping information by using the [**Add delivery info**](../../../api/escrow-api/add-delivery-info-api) and [**Update delivery info**](../../../api/escrow-api/update-delivery-info-api) APIs.
+
+ For escrow payment, the **`escrow`** parameter must be set to **true** .
+ When the escrow payment is completed, the merchant must register the shipping information for **settlement**.
+ You can manage shipping information by using the [**Add delivery info**](../../../api/escrow-api/add-delivery-info-api)
+ and [**Update delivery info**](../../../api/escrow-api/update-delivery-info-api) APIs.
-```javascript title="API Body Example"
-{
- "logis": {
+ ```json title="API Body Example"
+ {
+ "logis": {
"invoice": "1728384716123",
"company": "CJGLS",
"receiving_at": "20220215",
"address": "16, Seongsui-ro 20-gil"
- },
- "receiver": {
+ },
+ "receiver": {
"name": "John DOe"
- },
- "sender": {
+ },
+ "sender": {
"relationship": "self"
+ }
}
-}
-```
-
-
-**Precaution**
+ ```
-- When adding/updating the escrow delivery information, PAYJOA does not validate the delivery information (tracking number, courier name, etc.) received from the merchant.
-
-
+
+ **Precaution**
-
+ - When adding/updating the escrow delivery information, PAYJOA does not validate the delivery information
+ (tracking number, courier name, etc.) received from the merchant.
+
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/eximbay.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/eximbay.mdx
index 7cad6f0e1..1f551a4d0 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/eximbay.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/eximbay.mdx
@@ -4,143 +4,147 @@ description: Eximbay payment window integration guide
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Eximbay PG settings
+## 1. Configure Eximbay PG settings
Refer to the [**Eximbay settings**](../../ready/2.-pg/payment-gateway-settings/undefined-6) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
In PC and mobile browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'eximbay',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14.20,
- currency : 'USD',
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678', // Required
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456'
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "eximbay",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14.2,
+ currency: "USD",
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678", // Required
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-####
+ ### Key parameter description
-### Key parameter description
+ **`pg`** **\*** **string**
-**`pg`** **\***\*\* ****s****tring\*\*
+ **PG code**
-**PG code**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`eximbay`**.
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`eximbay`**.
+ **`pay_method`** **\*** **string**
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ **Payment method code**
-**Payment method code**
+
+
Payment method codes
-
-
Payment method codes
-
-- `card` (credit card)
-- `wechat`
-- `alipay`
-- `card` (foreign credit card)
-- `unionpay`
-- `tenpay`
-- `econtext` (payment via Japanese convenience store)
-
-
+ - `card` (credit card)
+ - `wechat`
+ - `alipay`
+ - `card` (foreign credit card)
+ - `unionpay`
+ - `tenpay`
+ - `econtext` (payment via Japanese convenience store)
+
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **`merchant_uid`** **\*** **string**
-**Order ID**
+ **Order ID**
-Must be unique for each request.\
+ Must be unique for each request.
-**`buyer_tel`****`*`****`string`**
+ **`buyer_tel`****\*****`string`**
-**`Customer phone`**
+ **`Customer phone`**
-**`amount`** **\***\*\* ****integer\*\*
+ **`amount`** **\*** **integer**
-**Payment amount**
+ **Payment amount**
-Must be an integer (not string)
+ Must be an integer (not string)
-**`currency`****`string`**
+ **`currency`****`string`**
-**Currency**
+ **Currency**
-- KRW
-- USD
-- EUR
-- GBP
-- JPY
-- THB
-- SGD
-- RUB
-- HKD
-- CAD
-- AUD
+ - KRW
+ - USD
+ - EUR
+ - GBP
+ - JPY
+ - THB
+ - SGD
+ - RUB
+ - HKD
+ - CAD
+ - AUD
-**` language`` `****`string`**
+ **`language`` `****`string`**
-- Korean : ko
-- English : en
-- Chinese : zh
-- Japanese : jp
-
-
+ - Korean : ko
+ - English : en
+ - Chinese : zh
+ - Japanese : jp
+
-### Note
-
-i'mport does not support Eximbay subscription payment.
+ ### Note
+ i'mport does not support Eximbay subscription payment.
-
How to test convenience store payment
+
How to test convenience store payment
+
+ ### Convenience store payment method
+
+ As with virtual accounts in Korea, payment is processed at the convenience store counter using the message sent to the customer by e-mail or text message after requesting payment via the payment window.
+
+ - i'mport internally sets pay\_method : vbank
+ - Sends callback and webhook to notify that Econtext has been created (status: ready / vbank\_num is fixed as unknown)
+ - When Econtext confirms payment deposit, i'mport receives a response from Eximbay, changes status to `paid`, and sends a webhook for post-payment processing
+
+ ### **Convenience store payment test procedure**
+
+ As with the virtual account, you need to test the result of the customer's deposit and receive a notification upon deposit.
-### Convenience store payment method
+ 1. Set Eximbay test mode to `ON` and proceed with the payment window.
-As with virtual accounts in Korea, payment is processed at the convenience store counter using the message sent to the customer by e-mail or text message after requesting payment via the payment window.
+ 2. Write down the `pg_tid` value from the callback response (check the value from the PG approval number column in the i'mport Admin console)
-- i'mport internally sets pay_method : vbank
-- Sends callback and webhook to notify that Econtext has been created (status: ready / vbank_num is fixed as unknown)
-- When Econtext confirms payment deposit, i'mport receives a response from Eximbay, changes status to `paid`, and sends a webhook for post-payment processing
+ 3. Log in from [http://test.econ.ne.jp/site/tuchi\_2/tuchi\_menu\_2.html](http://test.econ.ne.jp/site/tuchi_2/tuchi_menu_2.html) \
+ (ID: ectest / password: #eg0810# )
-### **Convenience store payment test procedure**
+ 4. ShopID : 361301, orderID : `pg_tid` (from step 2)
-As with the virtual account, you need to test the result of the customer's deposit and receive a notification upon deposit.
+ 5. Click **登録** button at the bottom
-1. Set Eximbay test mode to `ON` and proceed with the payment window.
-2. Write down the `pg_tid` value from the callback response (check the value from the PG approval number column in the i'mport Admin console)
-3. Log in from [http://test.econ.ne.jp/site/tuchi_2/tuchi_menu_2.html](http://test.econ.ne.jp/site/tuchi_2/tuchi_menu_2.html) \
- (ID: ectest / password: #eg0810# )
-4. ShopID : 361301, orderID : `pg_tid` (from step 2)
-5. Click **登録** button at the bottom
-6. On the next page, click **登録** button
-7. Wait 10 minutes and then check that the status is changed to **paid** (at this point, webhook is sent to notify of the deposit)
+ 6. On the next page, click **登録** button
+ 7. Wait 10 minutes and then check that the status is changed to **paid** (at this point, webhook is sent to notify of the deposit)
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/inicis.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/inicis.mdx
index f7eede393..48b9ce626 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/inicis.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/inicis.mdx
@@ -6,294 +6,289 @@ description: KG INICIS payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure KG INICIS settings
+## 1. Configure KG INICIS settings
-Refer to the [**KG INICIS settings**](../../ready/2.-pg/payment-gateway-settings/nhn-kcp-1) page to configure the PG settings.
+Refer to the [**KG INICIS settings**](../../ready/2.-pg/payment-gateway-settings/nhn-kcp-1) page
+to configure the PG settings.
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url** .
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url** .
-
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "html5_inicis",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
+
+ ### Key parameter description
+
+ **`pg`** **\*** **string**
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "html5_inicis",
- pay_method: "card",
- merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
- name: "Order name: Test payment request",
- amount: 14000,
- buyer_email: "iamport@siot.do",
- buyer_name: "John Doe",
- buyer_tel: "010-1234-5678",
- buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\*** **s** **tring**
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`html5_inicis`**.
-
-**`pay_method`** **\*** **s** **tring**
-
-**Payment method code**
-
-
-
Payment method codes
-
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `phone`(mobile micropayment)
-- `samsung`(Samsung Pay hub-type)
-- `kakaopay`(Kakao Pay)
-- `payco` ( PAYCO hub-type)
-- `tosspay` (Toss Simple Pay hub-type)
-- `ssgpay` (SSG Pay hub-type)
-- `chai` (CHAI Pay)
-- `lpay` (LPAY hub-type)
-- `naverpay` (Naver Pay)
-- `cultureland`(Cultureland)
-- `smartculture`(Smart Culture)
-- `happymoney`(Happy Money)
-
-
-
-**`merchant_uid`** **\*** **s** **tring**
-
-**Order ID**
-
-Must be unique for each request.
-
-**`amount`** **\*** **integer**
-
-**Payment amount**
-
-Must be an integer (not string)
-
-**`buyer_tel`** **`*`** **`string`**
-
-**Customer phone number**
-
-Required
-
-
-
-
-
-
-### You can request for a billing key through the KG INICIS payment window.
-
-- To open non-authenticated payment window, specify the **customer_uid** parameter.
-- After getting a billing key from the window, you can request payment using the billing key.
-- **`amount`** parameter is for display purpose only. Actual payment approval is not processed.
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "html5_inicis",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
+ **PG code**
-### Key parameter description
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`html5_inicis`**.
-**`pg`** **\*** **s** **tring**
+ **`pay_method`** **\*** **string**
-**PG code**
+ **Payment method code**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`html5_inicis`**.
+
+
Payment method codes
-> If you have multiple merchant IDs (each for general and subscription) issued by KG INCIS, set to `html5_inicis.{Merchant ID}` or `inicis.{Merchant ID}`(for ActiveX).
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+ - `samsung`(Samsung Pay hub-type)
+ - `kakaopay`(Kakao Pay)
+ - `payco` ( PAYCO hub-type)
+ - `tosspay` (Toss Simple Pay hub-type)
+ - `ssgpay` (SSG Pay hub-type)
+ - `chai` (CHAI Pay)
+ - `lpay` (LPAY hub-type)
+ - `naverpay` (Naver Pay)
+ - `cultureland`(Cultureland)
+ - `smartculture`(Smart Culture)
+ - `happymoney`(Happy Money)
+
-**`customer_uid`** **\*** **string**
+ **`merchant_uid`** **\*** **string**
-**Credit card billing key**
+ **Order ID**
+
+ Must be unique for each request.
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`amount`** **\*** **integer**
-**`amount`** **\*** **Integer**
+ **Payment amount**
-**Payment amount**
+ Must be an integer (not string)
-Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer_uid**.)\
+ **`buyer_tel`** **`*`** **`string`**
-### Request payment with billing key (customer_uid)
+ **Customer phone number**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ Required
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+
+
-
+
+ ### You can request for a billing key through the KG INICIS payment window.
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ - To open non-authenticated payment window, specify the **customer\_uid** parameter.
+ - After getting a billing key from the window, you can request payment using the billing key.
+ - **`amount`** parameter is for display purpose only. Actual payment approval is not processed.
-### Request one-time payment
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "html5_inicis",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+ ### Key parameter description
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ **`pg`** **\*** **string**
-###
+ **PG code**
-### Request billing key
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`html5_inicis`**.
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../api/billing-key-api/api-1).
+ > If you have multiple merchant IDs (each for general and subscription) issued by KG INCIS, set to `html5_inicis.{Merchant ID}` or `inicis.{Merchant ID}`(for ActiveX).
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ **`customer_uid`** **\*** **string**
-### Request billing key + initial payment
+ **Credit card billing key**
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-- **`customer_uid`** : required for saving the billing key.
+ **`amount`** **\*** **Integer**
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ **Payment amount**
-### Request payment with billing key
+ Amount to display in the payment window, but actual payment approval is not processed.
+ (To request payment, use the **REST API with the customer\_uid**.)
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+ ### Request payment with billing key (customer\_uid)
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1
+ with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-**For detailed information, refer to:**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-
+
+ **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-
-
+ ### Request one-time payment
-### 3. Additional functions
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-
-
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-```javascript title="javascript"
-display: {
- card_quota: [6]; // Display up to 6 months installment plans
-}
-```
+ ### Request billing key
-**Parameters**
+ To request a billing key, use the billing key request [**REST API POST /subscribe/customers/\{customer\_uid}**](../../api/billing-key-api/api-1).
-- **card_quota :**
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-
-Installment plan option is available only for **KRW 50,000 or more**.
+ ### Request billing key + initial payment
-
+ To request a billing key and initial payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-
+ - **`customer_uid`** : required for saving the billing key.
-
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-
+ ### Request payment with billing key
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
- }
-}
-```
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling the repeat pay
+ REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
-**Parameters**
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-- **code**: [ **Credit card code** ](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
+ **For detailed information, refer to:**
-
+
+
+
-
+## 3. Additional functions
-
+
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6] // Display up to 6 months installment plans
+ }
+ }
+ ```
+
+ **Parameters**
+
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\\
+
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
+
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ }
+ }
+ }
+ ```
-```javascript title="javascript"
-card: {
- detail: [
- { card_code: "*", enabled: false }, // Disable all credit cards
- { card_code: "366", enabled: true }, // Enable specific credit card
- ];
-}
-```
+ **Parameters**
-**Parameters**
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
+
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
-- **card_code:** [ **Credit card code** ](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **enabled:** Option to enable the credit card (**boolean**)
+ **Parameters**
-
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **enabled:** Option to enable the credit card (**boolean**)
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/jtnet.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/jtnet.mdx
index b00d17780..2bf0cb160 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/jtnet.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/jtnet.mdx
@@ -6,231 +6,233 @@ description: JTNet payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure JTNet settings
+## 1. Configure JTNet settings
Refer to the [**JTNET settings**](../../ready/2.-pg/payment-gateway-settings/jtnet) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "jtnet",
- pay_method: "card",
- merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
- name: "Order name: Test payment request",
- amount: 14000,
- buyer_email: "iamport@siot.do",
- buyer_name: "John Doe",
- buyer_tel: "010-1234-5678",
- buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "jtnet",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`jtnet`**.
+ **`pg`** **\*** **string**
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ **PG code**
-**Payment method code**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`jtnet`**.
-
-
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+
-**Order ID**
+ **`merchant_uid`** **\*** **string**
-Must be unique for each request.
+ **Order ID**
-**`amount`** **\***\*\* ****integer\*\*
+ Must be unique for each request.
-**Payment amount**
+ **`amount`** **\*** **integer**
-Must be an integer (not string)
+ **Payment amount**
-
+ Must be an integer (not string)
-
+
+
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter.
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter.
-
-#### **amount**
+
+ #### **amount**
-- If requesting **both billing key and initial payment**, specify the payment amount.
-- If only requesting for billing key, set to **0**.
+ - If requesting **both billing key and initial payment**, specify the payment amount.
+ - If only requesting for billing key, set to **0**.
+
-
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "jtnet",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "jtnet",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`jtnet`**.
+ **`pg`** **\*** **string**
->
+ **PG code**
-**`customer_uid`** **\***\*\* ****string\*\*
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`jtnet`**.
-**Credit card billing key**
+ >
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`customer_uid`** **\*** **string**
-**`amount`** **\***\*\* ****Integer\*\*
+ **Credit card billing key**
-**Payment amount**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-0: only billing key, **> 0: billing key + initial payment**\
+ **`amount`** **\*** **Integer**
-### Request payment with billing key (customer_uid)
+ **Payment amount**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ 0: only billing key, **> 0: billing key + initial payment**\\
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key (customer\_uid)
-
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-### Request one-time payment
+
+ **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+ ### Request one-time payment
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
-###
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-### Request billing key
+ ### Request billing key
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../api/billing-key-api/api-1).
+ To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer\_uid}**](../../api/billing-key-api/api-1).
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-### Request billing key + initial payment
+ ### Request billing key + initial payment
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-- **`customer_uid`** : required for saving the billing key.
+ - **`customer_uid`** : required for saving the billing key.
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-### Request payment with billing key
+ ### Request payment with billing key
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api))
+ with the `customer_uid` as follows:
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-**For detailed information, refer to:**
+ **For detailed information, refer to:**
-
-
-
+
+
-### 3. Additional functions
+## 3. Additional functions
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
-
-**Parameters**
-
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
-
-
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
+
+ **Parameters**
+
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
+ - **enabled:** Option to enable the credit card (**boolean)**
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/kg-mobilians.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/kg-mobilians.mdx
index a37496b30..9aac1b71d 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/kg-mobilians.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/kg-mobilians.mdx
@@ -5,161 +5,168 @@ description: KG Mobilians payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure KG Mobilians PG Settings
+## 1. Configure KG Mobilians PG Settings
Refer to the [**KG Mobilians settings**](../../ready/2.-pg/payment-gateway-settings/kg) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'mobilians',
- pay_method : 'phone',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678', //required
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-###
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`mobilians`**.
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "mobilians",
+ pay_method: "phone",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678", //required
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ ### Key parameter description
-**Payment method code**
+ **`pg`** **\*** **string**
-
-
Payment method codes
+ **PG code**
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `phone`(mobile micropayment)
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`mobilians`**.
-
+ **`pay_method`** **\*** **string**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **Payment method code**
-**Order ID**
+
+
Payment method codes
-Must be unique for each request.
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `phone`(mobile micropayment)
+
-**`buyer_tel`****`*`****`string`**
+ **`merchant_uid`** **\*** **string**
-**Customer phone number**
+ **Order ID**
-Required
+ Must be unique for each request.
-**`amount`** **\***\*\* ****integer\*\*
+ **`buyer_tel`****`*`** **`string`**
-**Payment amount**
+ **Customer phone number**
-Must be an integer (not string)
+ Required
-
+ **`amount`** **\*** **integer**
-
+ **Payment amount**
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.
+ Must be an integer (not string)
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "mobilians",
- pay_method: "phone",
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
+
+
-####
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter.
+ After getting a billing key from this window, you can request payment using the billing key.
-
-- To request non-authenticated payment, you must set the **MID info issued by KG Mobilians** in the Admin console.
-- KG Mobilians **does not process the payment** when issuing the billing key even if you specify an amount.
-- Subsequent payments using the billing key must be for the **same amount and on the same day** as the initial payment on monthly basis.
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "mobilians",
+ pay_method: "phone",
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-
+
+ - To request non-authenticated payment, you must set the **MID info issued by KG Mobilians** in the Admin console.
-### Key parameter description
+ - KG Mobilians **does not process the payment**
+ when issuing the billing key even if you specify an amount.
-**`pg`** **\***\*\* ****s****tring\*\*
+ - Subsequent payments using the billing key must be for
+ the **same amount and on the same day**
+ as the initial payment on monthly basis.
+
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`mobilians.[MID]`**.
+ **`pg`** **\*** **string**
-**`customer_uid`** **\***\*\* ****string\*\*
+ **PG code**
-**Credit card billing key**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`mobilians.[MID]`**.
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`customer_uid`** **\*** **string**
-**`amount`** **\***\*\* ****Integer\*\*
+ **Credit card billing key**
-**Payment amount**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer_uid**.)\
+ **`amount`** **\*** **Integer**
-### Request payment with billing key (customer_uid)
+ **Payment amount**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ Amount to display in the payment window, but actual payment approval is not processed.
+ (To request payment, use the **REST API with the customer\_uid**.)\\
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key (customer\_uid)
-
+ After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling the
+ [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
-#### **Not supported.**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-
+
+ #### **Not supported.**
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/kicc.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/kicc.mdx
index 1ad8bf70a..838b3ef6b 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/kicc.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/kicc.mdx
@@ -5,265 +5,270 @@ description: KICC payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure KICC PG settings
+## 1. Configure KICC PG settings
Refer to the [**KICC settings**](../../ready/2.-pg/payment-gateway-settings/kicc) page to configure
the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url** .
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url** .
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "kicc",
- pay_method: "card",
- merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
- name: "Order name: Test payment request",
- amount: 14000,
- buyer_email: "iamport@siot.do",
- buyer_name: "John Doe",
- buyer_tel: "010-1234-5678",
- buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
-
-###
-
-### Key parameter description
-
-**`pg`** **\*** **s** **tring**
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`kicc`**.
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kicc",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**`pay_method`** **\*** **s** **tring**
+ ### Key parameter description
-**Payment method code**
+ **`pg`** **\*** **string**
-
-
Payment method codes
+ **PG code**
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `phone`(mobile micropayment)
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`kicc`**.
-
+ **`pay_method`** **\*** **string**
-**`merchant_uid`** **\*** **s** **tring**
+ **Payment method code**
-**Order ID**
+
+
Payment method codes
-Must be unique for each request.
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+
-**`buyer_tel`** **`*`** **`string`**
+ **`merchant_uid`** **\*** **string**
-**Customer phone number**
+ **Order ID**
-**`amount`** **\*** **integer**
+ Must be unique for each request.
-**Payment amount**
+ **`buyer_tel`** **`*`** **`string`**
-Must be an integer (not string)
+ **Customer phone number**
-**`escrow`** **`boolean`**
+ **`amount`** **\*** **integer**
-**Escrow option**
+ **Payment amount**
-Only supports account transfer and virtual account payment.
+ Must be an integer (not string)
-
-
+ **`escrow`** **`boolean`**
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.
+ **Escrow option**
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "kicc",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
+ Only supports account transfer and virtual account payment.
-####
+
+
-
-- To request non-authenticated payment, you must set the **MID info issued by KICC** in the Admin console.
-- KICC **does not process the payment** when issuing the billing key even if you specify an amount.
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.
-
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kicc",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-### Key parameter description
+ ####
-**`pg`** **\*** \*\* ** **s** **tring\*\*
+
+ - To request non-authenticated payment, you must set the **MID info issued by KICC** in the Admin console.
+ - KICC **does not process the payment** when issuing the billing key even if you specify an amount.
+
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`kicc.[billing MID]`**.
+ **`pg`** **\*** **string**
-**`customer_uid`** **\*** **string**
+ **PG code**
-**Credit card billing key**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`kicc.[billing MID]`**.
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`customer_uid`** **\*** **string**
-**`amount`** **\*** **Integer**
+ **Credit card billing key**
-**Payment amount**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer_uid**.)\
+ **`amount`** **\*** **Integer**
-### Request payment with billing key (customer_uid)
+ **Payment amount**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer\_uid**.)\\
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key (customer\_uid)
-
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
-#### **Not supported.**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-
+
+ #### **Not supported.**
+
### 3. Additional functions
-
-KICC supports escrow payments only for **cash payment methods** (instant account transfer or virtual bank account).
-
-> To enable escrow payment, first set the following parameters and then configure additional parameters below.
->
-> - **escrow : true**
-
-### Additional parameters
-
-When making an escrow payment, you must enter the following required parameters:
-
-- `buyer_name` : Customer name
-- `buyer_email` : Customer email
-- `buyer_tel` : Customer phone number
-- `kiccProducts` : An array of objects consisting of the following 4 required properties. The `amount` value has no relation to the payment amount (`param.amount`) value and is not used for comparison.
- - `orderNumber` : Product order number
- - `name` : Product name
- - `quantity` : Quantity
- - `amount` : Product price
-
-```javascript title="JavaScript SDK"
-IMP.request_pay({
- ...
- escrow : true, // Required for escrow payment
- kiccProducts : [
- {
- "orderNumber" : "xxxx",
- "name" : "Product A",
- "quantity" : 3,
- "amount" : 1000
- },
- {
- "orderNumber" : "yyyy",
- "name" : "Product B",
- "quantity" : 2,
- "amount" : 3000
- }
- ]
- ...
-}, function(rsp) { // callback logic
- //* ...Omitted ... *//
-});
-```
-
-
-
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
+
+ KICC supports escrow payments only for **cash payment methods** (instant account transfer or virtual bank account).
+
+ > To enable escrow payment, first set the following parameters and then configure additional parameters below.
+ >
+ > - **escrow : true**
+
+ ### Additional parameters
+
+ When making an escrow payment, you must enter the following required parameters:
+
+ - `buyer_name` : Customer name
+
+ - `buyer_email` : Customer email
+
+ - `buyer_tel` : Customer phone number
+
+ - `kiccProducts` : An array of objects consisting of the following 4 required properties. The `amount` value has no relation to the payment amount (`param.amount`) value and is not used for comparison.
+ - `orderNumber` : Product order number
+ - `name` : Product name
+ - `quantity` : Quantity
+ - `amount` : Product price
+
+ ```ts title="JavaScript SDK"
+ IMP.request_pay(
+ {
+ escrow: true, // Required for escrow payment
+ kiccProducts: [
+ {
+ orderNumber: "xxxx",
+ name: "Product A",
+ quantity: 3,
+ amount: 1000,
+ },
+ {
+ orderNumber: "yyyy",
+ name: "Product B",
+ quantity: 2,
+ amount: 3000,
+ },
+ ],
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted ... *//
+ },
+ );
+ ```
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ }
+ }
}
-}
-```
-
-**Parameters**
-
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
-
-
-**Precautions**
-
-- Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
-
-
-
-
-
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
-
-**Parameters**
+ ```
+
+ **Parameters**
+
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
+
+
+ **Precautions**
+
+ - Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs.
+ You must check your Merchant ID with each PG for direct call support.
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
+ **Parameters**
-
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
+ - **enabled:** Option to enable the credit card (**boolean)**
-**Example of enabling only ****Shinhan Card**** payment
-window**" />
+
-
+ **Example of enabling only ****Shinhan Card**** payment
+ window**
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/nhh-kcp.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/nhh-kcp.mdx
index 0c50197fb..6ea521495 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/nhh-kcp.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/nhh-kcp.mdx
@@ -6,486 +6,519 @@ description: NHN KCP payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure NHH KCP PG settings
+## 1. Configure NHH KCP PG settings
-Refer to the [**NHN KCP settings**](../../ready/2.-pg/payment-gateway-settings/nhn-kcp) page to configure the PG settings.
+Refer to the [**NHN KCP settings**](../../ready/2.-pg/payment-gateway-settings/nhn-kcp) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'kcp',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- language : 'ko', // default: ko (Korean)
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to `kcp`.
-
-**`pay_method`** **\***\*\* ****s****tring\*\*
-
-**Payment method code**
-
-
-
Payment method codes
-
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `phone`(mobile micropayment)
-- `samsung`(Samsung Pay)
-- `kakaopay`(Kakao Pay)
-- `payco` ( PAYCO hub-type)
-- `lpay` (LPAY hub-type)
-- `naverpay` (Naver Pay)
-- `cultureland`(Cultureland)
-- `smartculture`(Smart Culture)
-- `happymoney`(Happy Money)
-- `booknlife`(Book culture gift certificate)
-- `point`(Benepia)
-
-
-
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
-
-**Order ID**
-
-Must be unique for each request.
-
-**`amount`** **\***\*\* ****integer\*\*
-
-**Payment amount**
-
-Must be an integer (not string).
-
-
-**For Payco hub-type**, you must apply through KCP Admin page and configure the settings.
-
-How to apply: [https://sir.kr/main/service/p_payco_hub.php](https://sir.kr/main/service/p_payco_hub.php)
-
-
-
-
-
-
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "kcp_billing",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
-
-
-* To request non-authenticated payment, you must set the **site code issued by KCP** in the Admin console.
-* KCP **does not process the payment** when issuing the billing key even if you specify an amount.
-
-
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kcp",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ language: "ko", // default: ko (Korean)
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
+
+ ### Key parameter description
+
+ **`pg`** **\*** **string**
+
+ **PG code**
+
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to `kcp`.
+
+ **`pay_method`** **\*** **string**
+
+ **Payment method code**
+
+
+
Payment method codes
+
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+ - `samsung`(Samsung Pay)
+ - `kakaopay`(Kakao Pay)
+ - `payco` ( PAYCO hub-type)
+ - `lpay` (LPAY hub-type)
+ - `naverpay` (Naver Pay)
+ - `cultureland`(Cultureland)
+ - `smartculture`(Smart Culture)
+ - `happymoney`(Happy Money)
+ - `booknlife`(Book culture gift certificate)
+ - `point`(Benepia)
+
+
+ **`merchant_uid`** **\*** **string**
+
+ **Order ID**
+
+ Must be unique for each request.
+
+ **`amount`** **\*** **integer**
+
+ **Payment amount**
+
+ Must be an integer (not string).
+
+
+ **For Payco hub-type**, you must apply through KCP Admin page and configure the settings.
+
+ How to apply: [https://sir.kr/main/service/p\_payco\_hub.php](https://sir.kr/main/service/p_payco_hub.php)
+
+
+
+
+
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter.
+ After getting a billing key from this window, you can request payment using the billing key.
-### Key parameter description
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kcp_billing",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-**`pg`** **\***\*\* ****s****tring\*\*
+
+ - To request non-authenticated payment, you must set the **site code issued by KCP** in the Admin console.
-**PG code**
+ - KCP **does not process the payment**
+ when issuing the billing key even if you specify an amount.
+
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to `kcp_billing`.
+ ### Key parameter description
-**`customer_uid`** **\***\*\* ****string\*\*
+ **`pg`** **\*** **string**
-**Credit card billing key**
+ **PG code**
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to `kcp_billing`.
-**`amount`** **\***\*\* ****Integer\*\*
+ **`customer_uid`** **\*** **string**
-**Payment amount**
+ **Credit card billing key**
-Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer_uid**.)\
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-### Request payment with billing key (customer_uid)
+ **`amount`** **\*** **Integer**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ **Payment amount**
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ Amount to display in the payment window, but actual payment approval is not processed.
+ (To request payment, use the **REST API with the customer\_uid**.)\\
-
+ ### Request payment with billing key (customer\_uid)
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-### Request one-time payment
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+
+ **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ### Request one-time payment
-###
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-### Request billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../api/billing-key-api/api-1).
+ ### Request billing key
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer\_uid}**](../../api/billing-key-api/api-1).
-### Request billing key + initial payment
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ ### Request billing key + initial payment
-- **`customer_uid`** : required for saving the billing key.
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ - **`customer_uid`** : required for saving the billing key.
-### Request payment with billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+ ### Request payment with billing key
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api))
+ with the `customer_uid` as follows:
-**For detailed information, refer to:**
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-
+ **For detailed information, refer to:**
-
+
+
-### 3. Additional functions
+## 3. Additional functions
-
-```javascript title="javascript"
-display: {
- card_quota: [6] // Display up to 6 months installment plans
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\
-
-
-Installment plan option is available only for **KRW 50,000 or more**.
-
-
-
-
-Example of allowing up to **3 months****
-installment plans**" />
-
-
-
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
- // When want to use points of credit card
- // quota: 80 = 80(Hyundai Card Point installment) + 0(pay all at once)
- // quota: 93 = 80(Hyundai Card Point installment) + 13(number of installments)
- // quota: 60 = 60(Other Card Point installment) + 0(pay all at once)
- // quota: 63 = 60(Other Card Point installment) + 3(number of installments)
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6] // Display up to 6 months installment plans
+ }
}
-}
-```
-
-**Parameters**
-
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. If you want to use points of credit card, you need to add the point installment per credit card[1] to number of installments (**integer**)
-
- [1] point installment per credit card
-
-
-
-
-
-
Point of Credit Card
-
-
-
Point Installment
-
-
-
-
-
Hyundai M
-
-
-
+80
-
-
-
-
-
Kookmin
-
-
-
+60
-
-
-
-
-
BC
-
-
-
+60
-
-
-
-
-
Samsung
-
-
-
+60
-
-
-
-
-
Hana/KEB
-
-
-
+60
-
-
-
-
-
Lotte
-
-
-
+60
-
-
-
-
-
Shinhan
-
-
-
+60
-
-
-
-
-
NongHyup
-
-
-
+60
-
-
-
-
-
Citi
-
-
-
+60
-
-
-
-
-
Woori
-
-
-
+60
-
-
-
-
-
-
-
-**Precautions**
-
-- Currently, direct call to the credit card company's payment window is only supported by 6 PGs: **KG Inicis, KCP, Toss Payments, Nice Payments, KICC, and Danal**.
-- Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
-
-
-
-
-
-
-
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
-
-**Parameters**
-
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
-
-
-
-
-
-
-Set the following parameter to only expose app cards for authenticated payments.
-
-```javascript title="request_pay()"
-...
-appCard : true . // Set to true to only expose app cards.
-...
-```
-
-
-
+ ```
-### 4. Additional parameters
+ **Parameters**
-
-
-To use the **gift certificate payment method**, set the merchant assigned user ID as follows:
-
-```javascript title="javascript SDK "
-bypass : {
- shop_user_id : ‘ABCD123’ // Merchant user ID (20 bytes)
-}
-```
-
-
-**This parameter is required for gift certificate providers' RM action.**
-
-
-
-**Example of paying with Cultureland gift certificate**
-
-```javascript
-MP.request_pay({
- pg : 'kcp.{Site code for gift certificate use}',
- pay_method : 'cultureland', //Gift certificate
- merchant_uid: "A00021-TEST",
- name : 'Carrots 10kg',
- amount : 1004,
- buyer_email : 'iamport@chai.finance',
- buyer_name : 'iamport tech support',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- bypass : {
- shop_user_id : 'abaddd' // Merchant user ID
- }
-}
-```
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\\
-
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
-
-For escrow payment, set the **`escrow`** parameter to **true**. To bundle products in the shopping cart when making an escrow payment request, pass the item-related information as an additional parameter (**`kcpProducts`**).
+
-**`kcpProducts`** is an object array consisting of the following four required properties:
+ Example of allowing up to **3 months**
+ **installment plans**
+
-**`amount`** is not related or compared with the payment amount (`param.amount`).
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ // When want to use points of credit card
+ // quota: 80 = 80(Hyundai Card Point installment) + 0(pay all at once)
+ // quota: 93 = 80(Hyundai Card Point installment) + 13(number of installments)
+ // quota: 60 = 60(Other Card Point installment) + 0(pay all at once)
+ // quota: 63 = 60(Other Card Point installment) + 3(number of installments)
+ }
+ }
+ }
+ ```
+
+ **Parameters**
+
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+
+ - **quota**: Installment plan. For immediate, set to 0. If you want to use points of credit card, you need to add the point installment per credit card\[1] to number of installments (**integer**)
+
+
+ \[1] point installment per credit card
+
+
+
+
+
+
Point of Credit Card
+
+
+
+
Point Installment
+
+
+
+
+
+
Hyundai M
+
+
+
+
+80
+
+
+
+
+
+
Kookmin
+
+
+
+
+60
+
+
+
+
+
+
BC
+
+
+
+
+60
+
+
+
+
+
+
Samsung
+
+
+
+
+60
+
+
+
+
+
+
Hana/KEB
+
+
+
+
+60
+
+
+
+
+
+
Lotte
+
+
+
+
+60
+
+
+
+
+
+
Shinhan
+
+
+
+
+60
+
+
+
+
+
+
NongHyup
+
+
+
+
+60
+
+
+
+
+
+
Citi
+
+
+
+
+60
+
+
+
+
+
+
Woori
+
+
+
+
+60
+
+
+
+
+
+
+
+ **Precautions**
+
+ - Currently, direct call to the credit card company's payment window is only supported by 6 PGs:
+ **KG Inicis, KCP, Toss Payments, Nice Payments, KICC, and Danal**.
+
+ - Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs.
+ You must check your Merchant ID with each PG for direct call support.
+
+
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
+
+ **Parameters**
-- orderNumber : Order ID
-- name : Product name
-- quantity : Product quantity
-- amount : Product price
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
+ - **enabled:** Option to enable the credit card (**boolean)**
-```javascript title="JavaScript SDK"
-IMP.request_pay({
- pg: "kcp",
- escrow: true, // For escrow payment
- kcpProducts: [
+
+
+
+
+ Set the following parameter to only expose app cards for authenticated payments.
+
+ ```json title="request_pay()"
{
- orderNumber: "xxxx",
- name: "Product A",
- quantity: 3,
- amount: 1000,
- },
+ "appCard": true // Set to true to only expose app cards.
+ }
+ ```
+
+
+
+## 4. Additional parameters
+
+
+
+ To use the **gift certificate payment method**, set the merchant assigned user ID as follows:
+
+ ```json title="javascript SDK"
{
- orderNumber: "yyyy",
- name: "Product B",
- quantity: 2,
- amount: 3000,
- },
- ],
- //* ...Omitted... *//
-});
-```
-
-
+ "bypass": {
+ "shop_user_id": "ABCD123" // Merchant user ID (20 bytes)
+ }
+ }
+ ```
+
+
+ **This parameter is required for gift certificate providers' RM action.**
+
+
+ **Example of paying with Cultureland gift certificate**
+
+ ```ts
+ IMP.request_pay({
+ pg: "kcp.{Site code for gift certificate use}",
+ pay_method: "cultureland", //Gift certificate
+ merchant_uid: "A00021-TEST",
+ name: "Carrots 10kg",
+ amount: 1004,
+ buyer_email: "iamport@chai.finance",
+ buyer_name: "iamport tech support",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ bypass: {
+ shop_user_id: "abaddd", // Merchant user ID
+ },
+ });
+ ```
+
+
+
+ For escrow payment, set the **`escrow`** parameter to **true**.
+ To bundle products in the shopping cart when making an escrow payment request,
+ pass the item-related information as an additional parameter (**`kcpProducts`**).
+
+ **`kcpProducts`** is an object array consisting of the following four required properties:
+
+ **`amount`** is not related or compared with the payment amount (`param.amount`).
+
+ - orderNumber : Order ID
+ - name : Product name
+ - quantity : Product quantity
+ - amount : Product price
+
+ ```ts title="JavaScript SDK"
+ IMP.request_pay({
+ pg: "kcp",
+ escrow: true, // For escrow payment
+ kcpProducts: [
+ {
+ orderNumber: "xxxx",
+ name: "Product A",
+ quantity: 3,
+ amount: 1000,
+ },
+ {
+ orderNumber: "yyyy",
+ name: "Product B",
+ quantity: 2,
+ amount: 3000,
+ },
+ ],
+ //* ...Omitted... *//
+ });
+ ```
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/nice.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/nice.mdx
index 62178fb2d..a786c42e7 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/nice.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/nice.mdx
@@ -5,243 +5,228 @@ description: NICE Payments payment window integration guideNICE
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure NICE Payments PG settings
+## 1. Configure NICE Payments PG settings
-Refer to the [**NICE Payments settings**](../../ready/2.-pg/payment-gateway-settings/nice-payments) page to configure the PG settings.
+Refer to the [**NICE Payments settings**](../../ready/2.-pg/payment-gateway-settings/nice-payments)
+page to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url** .
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url** .
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "nice",
- pay_method: "card",
- merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
- name: "Order name: Test payment request",
- amount: 14000,
- buyer_email: "iamport@siot.do",
- buyer_name: "John Doe",
- buyer_tel: "010-1234-5678",
- buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
- niceMobileV2: true, // Set to 'true' to enable new mobile version
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
-
-####
-
-### Key parameter description
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "nice",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ niceMobileV2: true, // Set to 'true' to enable new mobile version
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**`pg`** **\*** **s** **tring**
+ ### Key parameter description
-**PG code**
+ **`pg`** **\*** **string**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`nice`**.
+ **PG code**
-**`pay_method`** **\*** **s** **tring**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`nice`**.
-**Payment method code**
+ **`pay_method`** **\*** **string**
-
-
-
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `samsung`(Samsung Pay)
+ - `phone`(mobile micropayment)
+ - `kakaopay`(Kakao Pay)
+ - `payco` ( PAYCO hub-type)
+ - `naverpay` (Naver Pay)
+
-**`merchant_uid`** **\*** **s** **tring**
+ **`merchant_uid`** **\*** **string**
-**Order ID**
+ **Order ID**
-Must be unique for each request.
+ Must be unique for each request.
-**`amount`** **\*** **integer**
+ **`amount`** **\*** **integer**
-**Payment amount**
+ **Payment amount**
-Must be an integer (not string).
+ Must be an integer (not string).
-**`niceMobileV2`** **`boolean`**
+ **`niceMobileV2`** **`boolean`**
-Option to enable new NICE mobile version (default: false)
+ Option to enable new NICE mobile version (default: false)
-**`escrow`** **`boolean`**
+ **`escrow`** **`boolean`**
-**Ecrow option**
+ **Ecrow option**
-
+
+
-
+
+ **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ ### Request one-time payment
-### Request one-time payment
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ### Request billing key
-###
+ To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer\_uid}**](../../api/billing-key-api/api-1).
-### Request billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../api/billing-key-api/api-1).
+ ### Request billing key + initial payment
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-### Request billing key + initial payment
+ - **`customer_uid`** : required for saving the billing key.
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-- **`customer_uid`** : required for saving the billing key.
+ ### Request payment with billing key
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api))
+ with the `customer_uid` as follows:
-### Request payment with billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+
+ **NICE Payments supports non-authenticated payments only through the API method.**
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
-
-
-**NICE Payments supports non-authenticated payments only through the API method.**
-
-To integrate non-authenticated payments, you need to provide a UI for accepting user's card information. For more information, refer to the [**REST API**](../../auth/guide-1/bill/rest-api) page.
-
-
-
-
+ To integrate non-authenticated payments, you need to provide a UI for accepting user's card information.
+ For more information, refer to the [**REST API**](../../auth/guide-1/bill/rest-api) page.
+
+
-### 3. Additional functions
+## 3. Additional functions
-
-
-```javascript title="javascript"
-display: {
- card_quota: [6]; // Display up to 6 months installment plans
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans
-
-
-Installment plan option is available only for **KRW 50,000 or more**.
-
-
-
-
-
-
-
-
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6] // Display up to 6 months installment plans
+ }
}
-}
-```
-
-**Parameters**
-
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
-
-
-**Precautions**
+ ```
+
+ **Parameters**
+
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans
+
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
+
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ }
+ }
+ }
+ ```
-- Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
+ **Parameters**
-
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
-
+
+ **Precautions**
-
+ - Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs.
+ You must check your Merchant ID with each PG for direct call support.
+
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
+
+
-**Parameters**
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
-- **card_code:** [ **Credit card code** ](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **enabled:** Option to enable the credit card (**boolean**)
+ **Parameters**
-
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **enabled:** Option to enable the credit card (**boolean**)
-
+
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/paymentwall.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/paymentwall.mdx
index 3163f5cce..42f92d079 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/paymentwall.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/paymentwall.mdx
@@ -3,106 +3,107 @@ title: Paymentwall
description: Paymentwall payment window integration guide
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### 1. Configure Paymentwall PG settings
+## 1. Configure Paymentwall PG settings
Refer to the [**Paymentwall settings**](../../ready/2.-pg/payment-gateway-settings/undefined-1) page
to configure the PG settings.
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'paymentwall',
- pay_method : 'card', // In Paymentwall, the payment method is activated based on the country IP. (Can be omitted)
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- currency : 'KRW' // required
- buyer_email : 'iamport@siot.do', // required
- buyer_name : 'Jack Son', // Must include a space between Firstname Lastname
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}', // Example: https://www.my-service.com/payments/complete/mobile
- bypass: {
- // Set this for Terminal 3 only, Defualt: general payment window opens
- widget_code: "t3_1",
- // Set to enable specific payment method, set to 'all'(default) to enable all methods supported by your country
- ps : "all",
- country_code:"DE" // Set this to enable all payment methods supported by the country
- },
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-###
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "paymentwall",
+ pay_method: "card", // In Paymentwall, the payment method is activated based on the country IP. (Can be omitted)
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ currency: "KRW", // required
+ buyer_email: "iamport@siot.do", // required
+ buyer_name: "Jack Son", // Must include a space between Firstname Lastname
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ bypass: {
+ // Set this for Terminal 3 only, Defualt: general payment window opens
+ widget_code: "t3_1",
+ // Set to enable specific payment method, set to 'all'(default) to enable all methods supported by your country
+ ps: "all",
+ country_code: "DE", // Set this to enable all payment methods supported by the country
+ },
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`paymentwall`**.
+ **`pg`** **\*** **string**
-**`pay_method`** **s****tring**
+ **PG code**
-**Payment method code (Can be omitted)**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`paymentwall`**.
-You can manage your payment methods by enabling Project from the [Paymentwall website](https://api.paymentwall.com/).
+ **`pay_method`** **string**
-(Payment methods are enabled based on your country IP by default)
+ **Payment method code (Can be omitted)**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ You can manage your payment methods by enabling Project from the [Paymentwall website](https://api.paymentwall.com/).
-**Order ID**
+ (Payment methods are enabled based on your country IP by default)
-Must be unique for each request.
+ **`merchant_uid`** **\*** **string**
-**`amount`** **\***\*\* ****integer\*\*
+ **Order ID**
-**Payment amount**
+ Must be unique for each request.
-Must be an integer (not string)
+ **`amount`** **\*** **integer**
-**`buyer_name`****`*`****`string`**
+ **Payment amount**
-**`Customer name`**
+ Must be an integer (not string)
-**`buyer_email`****`*`****`string`**
+ **`buyer_name`****`*`****`string`**
-**`Customer email address`**
+ **`Customer name`**
-**`currency`****`*`****`string`**
+ **`buyer_email`****`*`****`string`**
-**`Currency`**
+ **`Customer email address`**
-**`bypass`**
+ **`currency`****`*`****`string`**
-**`Paymentwall specific parameter`**
+ **`Currency`**
-- **`widget_code` :** Set this to **t3_1** for Terminal 3 only, Defualt: general payment window
-- **`ps` :** Set to enable specific payment method. For available codes, refer to [**Payment system short codes**](https://docs.paymentwall.com/reference/payment-system-shortcodes). Example: `kakaopaykr` = Kakao Pay
-- **country_code** : Payment methods are shown based on this code. ([**Country codes**](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))
+ **`bypass`**
-
+ **`Paymentwall specific parameter`**
-
-**Preparing for service**
+ - **`widget_code` :** Set this to **t3\_1** for Terminal 3 only, Defualt: general payment window
+ - **`ps` :** Set to enable specific payment method. For available codes, refer to [**Payment system short codes**](https://docs.paymentwall.com/reference/payment-system-shortcodes). Example: `kakaopaykr` = Kakao Pay
+ - **country\_code** : Payment methods are shown based on this code. ([**Country codes**](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))
+
-
+
+ **Preparing for service**
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/paypal.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/paypal.mdx
index f19fd008e..ae507ae79 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/paypal.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/paypal.mdx
@@ -4,97 +4,96 @@ description: PayPal payment window integration guide
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure PayPal PG settings
+## 1. Configure PayPal PG settings
Refer to the [**PayPal settings**](../../ready/2.-pg/payment-gateway-settings/undefined-5) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC and mobile browsers, the page is redirected to **m_redirect_url**.
+In PC and mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'paypal',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14.20,
- currency : 'USD' // default: USD (KRW not supported)
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678', // Required
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456'
- m_redirect_url : '{URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "paypal",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14.2,
+ currency: "USD", // default: USD (KRW not supported)
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678", // Required
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-####
+ ### Key parameter description
-### Key parameter description
+ **`pg`** **\*** **string**
-**`pg`** **\***\*\* ****s****tring\*\*
+ **PG code**
-**PG code**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`paypal`**.
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`paypal`**.
+ **`pay_method`** **\*** **string**
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ **Payment method code**
-**Payment method code**
+
+
Payment method codes
-
-
Payment method codes
+ - `card` (credit card)
+
-- `card` (credit card)
+ **`merchant_uid`** **\*** **string**
-
+ **Order ID**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ Must be unique for each request.
-**Order ID**
+ **`amount`** **\*** **integer**
-Must be unique for each request.
+ **Payment amount**
-**`amount`** **\***\*\* ****integer\*\*
+ Must be an integer (not string)\
+ \
+ **`currency`****`*`****`string`**
-**Payment amount**
+ **Currency**
-Must be an integer (not string)\
-\
-**`currency`****`*`****`string`**
+ For supported currencies, refer to [PayPal currency codes](https://developer.paypal.com/docs/api/reference/currency-codes/#paypal-account-payments).
-**Currency**
+ **`m_redirect_url`****`*`****`string`**
-For supported currencies, refer to [PayPal currency codes](https://developer.paypal.com/docs/api/reference/currency-codes/#paypal-account-payments).
+ **Redirect URL**
-**`m_redirect_url`****`*`****`string`**
-
-**Redirect URL**
-
-Required in both PC and mobile to receive payment result.
-
-
+ Required in both PC and mobile to receive payment result.
+
-### Note
-
-i'mport does not support PayPal subscription payment.
+ ### Note
+ i'mport does not support PayPal subscription payment.
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/readme.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/readme.mdx
index 36434112e..53b797357 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/readme.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/readme.mdx
@@ -3,4 +3,4 @@ title: Payment gateways
description: Learn how to integrate with each PG.
---
-### Learn how to integrate authenticated and non-authenticated payments by PG.
+Learn how to integrate authenticated and non-authenticated payments by PG.
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/settlebank.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/settlebank.mdx
index 72763a2f5..0bcc5b9e1 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/settlebank.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/settlebank.mdx
@@ -6,148 +6,150 @@ description: Settlebank payment window integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import ContentRef from "~/components/gitbook/ContentRef.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure **Settlebank** PG settings
+## 1. Configure **Settlebank** PG settings
-Refer to the [**Settlebank settings**](../../ready/2.-pg/payment-gateway-settings/undefined-3) page to configure the PG settings.
+Refer to the [**Settlebank settings**](../../ready/2.-pg/payment-gateway-settings/undefined-3) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'settle',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678', // Required
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- company : 'iamport', // Recommended for virtual account payment
- buyer_postcode : '123-456',
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`settle`**.
-
-**`pay_method`** **\***\*\* ****s****tring\*\*
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "settle",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678", // Required
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ company: "iamport", // Recommended for virtual account payment
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**Payment method code**
+ ### Key parameter description
-
-
Payment method codes
+ **`pg`** **\*** **string**
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
-- `phone`(mobile micropayment)
+ **PG code**
-
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`settle`**.
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **`pay_method`** **\*** **string**
-**Order ID**
+ **Payment method code**
-Must be unique for each request.
+
+
Payment method codes
-**`amount`** **\***\*\* ****integer\*\*
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+
-**Payment amount**
+ **`merchant_uid`** **\*** **string**
-Must be an integer (not string)
+ **Order ID**
-**`buyer_tel`****`*`****`string`**
+ Must be unique for each request.
-**Customer phone number**
+ **`amount`** **\*** **integer**
-Required
+ **Payment amount**
-**` company`` `****`string`**
+ Must be an integer (not string)
-**`Company name`**
+ **`buyer_tel`****`*`****`string`**
-Required for virtual account payment
+ **Customer phone number**
-
+ Required
-
+ **`company`` `****`string`**
-
-#### Not supported
+ **`Company name`**
-
+ Required for virtual account payment
-
-#### **You can use i'mport REST API to request payment and schedule payment.**
+
+
-### Request one-time payment
+
+ #### Not supported
+
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+
+ #### **You can use i'mport REST API to request payment and schedule payment.**
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ### Request one-time payment
-### Request billing key + initial payment
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-- **`customer_uid`** : required for saving the billing key.
+ ### Request billing key + initial payment
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-### Request payment with billing key
+ - **`customer_uid`** : required for saving the billing key.
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key
-
-**Settlebank does not support** [**Request billing key API**](../../api/billing-key-api/api-1)**.**
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api))
+ with the `customer_uid` as follows:
-
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-**For detailed information, refer to:**
+
+ **Settlebank does not support** [**Request billing key API**](../../api/billing-key-api/api-1)**.**
+
-
+ **For detailed information, refer to:**
-
+
+
diff --git a/src/content/docs/en/payment-integration-by-pg/payment-gateways/smartro.mdx b/src/content/docs/en/payment-integration-by-pg/payment-gateways/smartro.mdx
index e7659d1c7..1ca6e100e 100644
--- a/src/content/docs/en/payment-integration-by-pg/payment-gateways/smartro.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/payment-gateways/smartro.mdx
@@ -4,78 +4,79 @@ description: Smartro payment window integration guide
---
import Details from "~/components/gitbook/Details.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### 1. Configure Smartro PG settings
+## 1. Configure Smartro PG settings
Refer to the [**Smartro settings**](../../ready/2.-pg/payment-gateway-settings/undefined-4) page to
configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'smartro',
- pay_method : 'card',
- merchant_uid : '{Merchant created Order ID}', // Example: order_no_0001
- name : 'Order name: Test payment request',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'John Doe',
- buyer_tel : '010-1234-5678', // Required
- buyer_addr : 'Shinsa-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : '{Mobile only - URL to redirect to after payment approval}' // Example: https://www.my-service.com/payments/complete/mobile
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "smartro",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", // Example: order_no_0001
+ name: "Order name: Test payment request",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "John Doe",
+ buyer_tel: "010-1234-5678", // Required
+ buyer_addr: "Shinsa-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`smartro`**.
+ **`pg`** **\*** **string**
-**`pay_method`** **\***\*\* ****s****tring\*\*
+ **PG code**
-**Payment method code**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`smartro`**.
-
-
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+ - `phone`(mobile micropayment)
+
-**Order ID**
+ **`merchant_uid`** **\*** **string**
-Must be unique for each request.
+ **Order ID**
-**`amount`** **\***\*\* ****integer\*\*
+ Must be unique for each request.
-**Payment amount**
+ **`amount`** **\*** **integer**
-Must be an integer (not string).
+ **Payment amount**
-**` escrow`` `****`boolean`**
+ Must be an integer (not string).
-**Ecrow option**
+ **`escrow`` `****`boolean`**
-
+ **Ecrow option**
-
+
+
-
-To open non-authenticated payment window, specify the **customer\_uid** parameter. After getting a billing key from this window, you can request payment using the billing key.
+
+ To open non-authenticated payment window, specify the **customer\_uid** parameter.
+ After getting a billing key from this window, you can request payment using the billing key.
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "tosspayments",
- pay_method: "card", // only 'card' supported.
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Initial billing key request",
- amount: 0, // For display purpose only (no payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
- customer_id: "matthew", // Merchant user ID
- },
- function (rsp) {
- // callback
- }
-);
-```
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "tosspayments",
+ pay_method: "card", // only 'card' supported.
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Initial billing key request",
+ amount: 0, // For display purpose only (no payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{redirect URL}", // Example: https://www.my-service.com/payments/complete/mobile (for mobile only)
+ customer_id: "matthew", // Merchant user ID
+ },
+ function (rsp) {
+ // callback
+ },
+ );
+ ```
-
-* To request non-authenticated payment, you must set the **MID issued by Toss Payments** in the Admin console.
-* Toss Payments **does not process the payment** when issuing the billing key even if you specify an amount.
-
-
-
-### Key parameter description
+
+ - To request non-authenticated payment, you must set the **MID issued by Toss Payments** in the Admin console.
-**`pg`** **\***\*\* ****s****tring\*\*
+ - Toss Payments **does not process the payment**
+ when issuing the billing key even if you specify an amount.
+
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`tosspayments`**.
+ **`pg`** **\*** **string**
-**`customer_uid`** **\***\*\* ****string\*\*
+ **PG code**
-**Credit card billing key**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`tosspayments`**.
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`customer_uid`** **\*** **string**
-**`amount`** **\***\*\* ****Integer\*\*
+ **Credit card billing key**
-**Payment amount**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer_uid**.)
+ **`amount`** **\*** **Integer**
-**`customer_id`** **\***\*\* ****string\*\*
+ **Payment amount**
-**Customer ID**
+ Amount to display in the payment window, but actual payment approval is not processed. (To request payment, use the **REST API with the customer\_uid**.)
-Customer user ID that maps to billing key. If not specified, this is generated by i'mport.\
+ **`customer_id`** **\*** **string**
-### Request payment with billing key (customer_uid)
+ **Customer ID**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ Customer user ID that maps to billing key. If not specified, this is generated by i'mport.\\
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key (customer\_uid)
-
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
-#### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-
-**MID Issuance**
-
-When you get an MID from Toss Payments, the **API version** must be **1.4**.
-
-
+
+ #### **You can use i'mport REST API to request billing key, request payment, and schedule payment.**
-### Request one-time payment
+
+ **MID Issuance**
-To request a one-time payment, use the key-in REST[ **API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api). The card information is not saved during this process.
+ When you get an MID from Toss Payments, the **API version** must be **1.4**.
+
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ ### Request one-time payment
-###
+ To request a one-time payment, use the key-in [**REST API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ The card information is not saved during this process.
-### Request billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer_uid}**](../../api/billing-key-api/api-1).
+ ### Request billing key
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
- https://api.iamport.kr/subscribe/customers/your-customer-unique-id
-```
+ To request a billing key, use the billing key request REST [**API POST /subscribe/customers/\{customer\_uid}**](../../api/billing-key-api/api-1).
-### Request billing key + initial payment
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"card_number":"1234-1234-1234-1234", "expiry":"2025-12", "birth":"820213", "pwd_2digit":"00"}' \
+ https://api.iamport.kr/subscribe/customers/your-customer-unique-id
+ ```
-To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
+ ### Request billing key + initial payment
-- **`customer_uid`** : required for saving the billing key.
+ To request a billing key and initial payment, use the key-in REST [**API POST /subscribe/payments/onetime**](../../api/api/request-non-authenticated-payment-one-time-api).
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/onetime
-```
+ - **`customer_uid`** : required for saving the billing key.
-### Request payment with billing key
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "card_number":"1234-1234-1234-1234", "expiry":"2019-01", "birth":"123456", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/onetime
+ ```
-After successfully getting the billing key and making the initial payment, the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api)) with the `customer_uid` as follows:
+ ### Request payment with billing key
-```
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ After successfully getting the billing key and making the initial payment,
+ the billing key is stored on the i'mport server mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the repeat pay REST API ([**POST /subscribe/payments/again**](../../api/api/api))
+ with the `customer_uid` as follows:
-**For detailed information, refer to:**
+ ```sh
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
-
+ **For detailed information, refer to:**
-
+
+
### 3. Additional functions
-
-```javascript title="javascript"
-display: {
- card_quota: [6], // Display up to 6 months installment plans
- only_installment: true // Disable immediate pay option
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - Enable only specified installment months
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans
-- If **only_installment: `true`**, only shows specified months in **`card_quota`**.\
-
-
-Installment plan option is available only for **KRW 50,000 or more**.
-
-
-
-
-
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6], // Display up to 6 months installment plans
+ "only_installment": true // Disable immediate pay option
+ }
}
-}
-```
-
-**Parameters**
-
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
-
-
-
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
-
-**Parameters**
+ ```
+
+ **Parameters**
+
+ - **card\_quota :**
+ - Enable only specified installment months
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans
+
+ - If **only\_installment: `true`**, only shows specified months in **`card_quota`**.\\
+
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ }
+ }
+ }
+ ```
+
+ **Parameters**
+
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
+
+
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true }, // Enable specific credit card
+ ]
+ }
+ }
+ ```
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
+ **Parameters**
-
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) **(string)**
+ - **enabled:** Option to enable the credit card (**boolean)**
+
-**Hub-type simple payment**
-
-Simple payments (Kakao Pay, Naver Pay, etc.) are not supported in Toss Payments payment window.
+ **Hub-type simple payment**
+ Simple payments (Kakao Pay, Naver Pay, etc.) are not supported in Toss Payments payment window.
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/alipay.mdx b/src/content/docs/en/payment-integration-by-pg/simple/alipay.mdx
index 1a3c3fb89..b7efa1598 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/alipay.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/alipay.mdx
@@ -3,71 +3,72 @@ title: Alipay
description: Alipay simple payment integration guide
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### 1. Configure Alipay simple payment PG settings
+## 1. Configure Alipay simple payment PG settings
Refer to the [**Alipay settings**](../../ready/2.-pg/pg/undefined-5) page to configure the PG
settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-After calling `IMP.request_pay(param, callback)`, the page is redirected to **m_redirect_url**.
+After calling `IMP.request_pay(param, callback)`, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'alipay',
- merchant_uid: '{Merchant created Order ID}', //Example: order_no_0001
- name : 'Order name: Test payment',
- amount : 1.20, // USD
- currency : 'USD' // Default: USD
- buyer_email : 'iamport@siot.do',
- buyer_name : 'Customer name',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Samseong-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : "{URL to redirect to after payment approval}" //Example: http://yourservice.com/payments/complete
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
-
-### Key parameter description
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "alipay",
+ merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
+ name: "Order name: Test payment",
+ amount: 1.2, // USD
+ currency: "USD", // Default: USD
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{URL to redirect to after payment approval}", //Example: http://yourservice.com/payments/complete
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**`pg`** **\***\*\* ****s****tring\*\*
+ ### Key parameter description
-**PG code**
+ **`pg`** **\*** **string**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`alipay`**.
+ **PG code**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`alipay`**.
-**Order ID**
+ **`merchant_uid`** **\*** **string**
-Must be unique for each request.
+ **Order ID**
-**` currency`` `****`string`**
+ Must be unique for each request.
-**Currency code**
+ **`currency`` `****`string`**
-Default: USD (KRW supported)
+ **Currency code**
-**`amount`** **\***\*\* ****integer\*\*
+ Default: USD (KRW supported)
-**Payment amount**
+ **`amount`** **\*** **integer**
-Must be an integer (not string)
+ **Payment amount**
-
+ Must be an integer (not string)
+
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/kakao-pay.mdx b/src/content/docs/en/payment-integration-by-pg/simple/kakao-pay.mdx
index b2314d5e1..3834f5774 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/kakao-pay.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/kakao-pay.mdx
@@ -4,150 +4,152 @@ description: Kakao Pay simple payment integration guide
---
import Codepen from "~/components/gitbook/Codepen.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Kakao Pay simple payment PG settings
+## 1. Configure Kakao Pay simple payment PG settings
-Refer to the [**Kakao Pay settings**](../../ready/2.-pg/pg/undefined) page to configure the PG settings.
+Refer to the [**Kakao Pay settings**](../../ready/2.-pg/pg/undefined) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'kakaopay',
- pay_method : 'card', // Can be omitted
- merchant_uid: '{Merchant created Order ID}', //Example: order_no_0001
- name : 'Order name: Test payment',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'Customer name',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Samseong-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : "{URL to redirect to after payment approval}" //Example: http://yourservice.com/payments/complete
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kakaopay",
+ pay_method: "card", // Can be omitted
+ merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
+ name: "Order name: Test payment",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{URL to redirect to after payment approval}", //Example: http://yourservice.com/payments/complete
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-### Key parameter description
+ ### Key parameter description
-**`pg`** **\***\*\* ****s****tring\*\*
+ **`pg`** **\*** **string**
-**PG code**
+ **PG code**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`kakaopay`**.
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`kakaopay`**.
-**`pay_method`** **s****tring**
+ **`pay_method`** **string**
-**Payment method code**
+ **Payment method code**
-Can be omitted
+ Can be omitted
-(Overwritten by the option(credit card or Kakao money) selected in Kakao Pay app)
+ (Overwritten by the option(credit card or Kakao money) selected in Kakao Pay app)
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **`merchant_uid`** **\*** **string**
-**Order ID**
+ **Order ID**
-Must be unique for each request.
+ Must be unique for each request.
-**`amount`** **\***\*\* ****integer\*\*
+ **`amount`** **\*** **integer**
-**Payment amount**
+ **Payment amount**
-Must be an integer (not string)
+ Must be an integer (not string)
-
+
+
-
+
+ To open subscription payment window, specify the **customer\_uid** parameter.
-
-To open subscription payment window, specify the **customer\_uid** parameter.
+
+ **amount**
-
-**amount**
+ - If requesting **both billing key and initial payment**, specify the payment amount.
+ - If only requesting for billing key, set to **0**.
+
-- If requesting **both billing key and initial payment**, specify the payment amount.
-- If only requesting for billing key, set to **0**.
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "kakaopay",
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Order name: Billing key request test",
+ amount: 0, // For display purpose only (set actual amount to also request payment approval).
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-
-
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "kakaopay",
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Order name: Billing key request test",
- amount: 0, // For display purpose only (set actual amount to also request payment approval).
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- m_redirect_url: "{Mobile only - URL to redirect to after payment approval}", // Example: https://www.my-service.com/payments/complete/mobile
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
-
-### Key parameter description
+ ### Key parameter description
-**`pg`** **\***\*\* ****s****tring\*\*
+ **`pg`** **\*** **string**
-**PG code**
+ **PG code**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`kakaopay`**.
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`kakaopay`**.
-**`customer_uid`** **\***\*\* ****string\*\*
+ **`customer_uid`** **\*** **string**
-**Credit card billing key**
+ **Credit card billing key**
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-**`amount`** **\***\*\* ****Integer\*\*
+ **`amount`** **\*** **Integer**
-**Payment amount**
+ **Payment amount**
-0: only billing key, **> 0: billing key + initial payment**\
+ 0: only billing key, **> 0: billing key + initial payment**\\
-### Request payment with billing key (customer_uid)
+ ### Request payment with billing key (customer\_uid)
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
-
-
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-**Kakao Pay simple payment is processed in mobile Kakao App.**
-
+ **Kakao Pay simple payment is processed in mobile Kakao App.**
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/naver-pay-standard.mdx b/src/content/docs/en/payment-integration-by-pg/simple/naver-pay-standard.mdx
index 7d9a3ccf9..8ccd4437a 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/naver-pay-standard.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/naver-pay-standard.mdx
@@ -4,353 +4,376 @@ description: "\bNaver Pay simple payment integration guide"
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Naver Pay simple payment PG settings
+## 1. Configure Naver Pay simple payment PG settings
Refer to the [**Naver Pay settings**](../../ready/2.-pg/pg/undefined-2) page to configure the PG
settings.
![]()
-### 2. Request payment
+## 2. Request payment
To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
-IMP.**request_pay**(param, callback).
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'naverpay',
- merchant_uid: '{Merchant created Order ID}', //Example: order_no_0001
- name : 'Order name: Test payment',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'Customer name',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Samseong-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- naverUseCfm : '20201001', //Expiration date
- naverPopupMode : true, //Enable popup mode
- m_redirect_url : "{URL to redirect to after payment approval}", //Example: http://yourservice.com/payments/complete
- naverPurchaserName: "Purchaser name",
- naverPurchaserBirthday: "20151201",
- naverProducts : [{
- "categoryType": "BOOK",
- "categoryId": "GENERAL",
- "uid": "107922211",
- "name": "History of the World",
- "payReferrer": "NAVER_BOOK",
- "count": 10
- },
- {
- "categoryType": "MUSIC",
- "categoryId": "CD",
- "uid": "299911002",
- "name": "BTS",
- "payReferrer": "NAVER_BOOK",
- "count": 1
- }]
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "naverpay",
+ merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
+ name: "Order name: Test payment",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ naverUseCfm: "20201001", //Expiration date
+ naverPopupMode: true, //Enable popup mode
+ m_redirect_url: "{URL to redirect to after payment approval}", //Example: http://yourservice.com/payments/complete
+ naverPurchaserName: "Purchaser name",
+ naverPurchaserBirthday: "20151201",
+ naverProducts: [
+ {
+ categoryType: "BOOK",
+ categoryId: "GENERAL",
+ uid: "107922211",
+ name: "History of the World",
+ payReferrer: "NAVER_BOOK",
+ count: 10,
+ },
+ {
+ categoryType: "MUSIC",
+ categoryId: "CD",
+ uid: "299911002",
+ name: "BTS",
+ payReferrer: "NAVER_BOOK",
+ count: 1,
+ },
+ ],
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
+
+ ### Key parameter description
+
+ **`pg`** **\*** **string**
+
+ **PG code**
+
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`naverpay`**.
+
+ **`merchant_uid`** **\*** **string**
+
+ **Order ID**
+
+ Must be unique for each request.
+
+ **`amount`** **\*** **integer**
+
+ **Payment amount**
+
+ Must be an integer (not string)
+
+ **`naverUseCfm`` `****`string`**
+
+ **Expiration date** (string in yyyyMMdd format, **must be on or after the date of payment**).
-####
+ - Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
-### Key parameter description
+ **`name`****`*`****`string`**
-**`pg`** **\***\*\* ****s****tring\*\*
+ **`Product name`**
-**PG code**
+ If multiple products are defined in the `naverProducts` parameter, Naver Pay automatically appends `and 2 others`. Hence, set this to the name of the first product (`naverProducts[0].name`) in the array.
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`naverpay`**.
+ **`naverPopupMode`` `****`boolean`**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **Option to proceed via popup window**
-**Order ID**
+ - If `false`, payment process will proceed via page redirection and you must specify `m_redirect_url`.
-Must be unique for each request.
+ **`m_redirect_url`****`string`**
-**`amount`** **\***\*\* ****integer\*\*
+ **`Redirect URL`**
-**Payment amount**
+ - URL to redirect to after payment approval when using redirection method (`naverPopupMode`: **false**).
-Must be an integer (not string)
+ **`naverPurchaserName`****`string`**
-**` naverUseCfm`` `****`string`**
+ **`Name of the purchaser`**
-**Expiration date** (string in yyyyMMdd format, **must be on or after the date of payment**).
+ **Only required for merchants** who have been instructed
+ to enter this information at the time of the Naver Pay contract because the product
+ falls under a high-risk industry.
-- Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
+ **`naverPurchaserBirthday`` `****`string`**
-**`name`****`*`****`string`**
+ **`Purchaser's DOB (yyyyMMdd)`**
-**`Product name`**
+ **Only required for merchants** who have been instructed
+ to enter this information at the time of the Naver Pay contract because the product
+ falls under a high-risk industry.
-If multiple products are defined in the `naverProducts` parameter, Naver Pay automatically appends `and 2 others`. Hence, set this to the name of the first product (`naverProducts[0].name`) in the array.
+ **`naverChainId`** **`string`**
-**` naverPopupMode`` `****`boolean`**
+ Enter the value received from Naver Pay only for group-type merchants that operate two or more services with the same partner ID.
-**Option to proceed via popup window**
+ Non-target merchants are not entered.
-- If `false`, payment process will proceed via page redirection and you must specify `m_redirect_url`.
+ **`naverProducts`****`*`****`array`**
-**`m_redirect_url`****`string`**
+ **`Product information`**
-**`Redirect URL`**
+ Same as the **`productItems`** parameter defined in Naver Pay manual.
-- URL to redirect to after payment approval when using redirection method (`naverPopupMode`: **false**).
+ (If omitted, request will fail Naver Pay's inspection.)
-**`naverPurchaserName`****`string`**
+ **`naverProducts`** is an array of objects consisting of the following 6 properties:
-**`Name of the purchaser`**
+ - **`categoryType`** (Required): Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-**Only required for merchants** who have been instructed
-to enter this information at the time of the Naver Pay contract because the product
-falls under a high-risk industry.
+ - **`categoryId`** (Required): Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-**` naverPurchaserBirthday`` `****`string`**
+ - **`uid`** (Required) : Merchant created product ID in general. Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-**`Purchaser's DOB (yyyyMMdd)`**
+ - **`name`** (Required) : Product name
-**Only required for merchants** who have been instructed
-to enter this information at the time of the Naver Pay contract because the product
-falls under a high-risk industry.
+ - **`count`** (Required) : Selected quantity
-**`naverChainId`** **`string`**
+ - **`sellerId`** (Optional) : Unique ID used by merchants to identify sub-merchants (uppercase and lowercase letters and numbers allowed)
+ - Only required for mail order brokerage merchants who have been instructed to enter this information at the time of the Naver Pay contract.
+ - Not required for other merchants.
-Enter the value received from Naver Pay only for group-type merchants that operate two or more services with the same partner ID.
+ - **`payReferrer`** (Optional) : Funnel path to Naver Pay. Enter only when in partnership agreement with other services on the Naver platform.
+ Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product_ref).
+
-Non-target merchants are not entered.
+
+ ## Request billing key
-\
-**`naverProducts`****`*`****`array`**
+ ```ts title="JavaScript SDK"
+ IMP.request_pay(
+ {
+ pg: "naverpay",
+ customer_uid: "gildong_0001_1234", //billing, required.
+ merchant_uid: "{Merchant created Order ID}", //Example: order_monthly_0001
+ name: "Slim plan (montly)",
+ amount: 14000, // For display only, no payment approval
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678", //Required
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ naverProductCode: "Recurring payment product code",
+ naverPopupMode: true, //Enable popup mode
+ m_redirect_url: "{URL to redirect to after registration}", //Example: http://yourservice.com/payments/complete
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**`Product information`**
+ ### Key parameter description
-Same as the **`productItems`** parameter defined in Naver Pay manual.
+ **`pg`** **\*** **string**
-(If omitted, request will fail Naver Pay's inspection.)
+ **PG code**
-> **`naverProducts`** is an array of objects consisting of the following 6 properties:
->
-> - **`categoryType`** (Required): Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-> - **`categoryId`** (Required): Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-> - **`uid`** (Required) : Merchant created product ID in general. Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product)
-> - **`name`** (Required) : Product name
-> - **`count`** (Required) : Selected quantity
-> - **`sellerId`** (Optional) : Unique ID used by merchants to identify sub-merchants (uppercase and lowercase letters and numbers allowed)
-> - Only required for mail order brokerage merchants who have been instructed to enter this information at the time of the Naver Pay contract.
-> - Not required for other merchants.
-> - **`payReferrer`** (Optional) : Funnel path to Naver Pay. Enter only when in partnership agreement with other services on the Naver platform. Refer to [NPay Developers](https://developer.pay.naver.com/docs/v2/api#etc-etc_product_ref).
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`naverpay`**.
-
+ **`customer_uid`****`*`****`string`**
-
-## Request billing key
+ **`Billing key`**
-```javascript title="JavaScript SDK"
-IMP.request_pay(
- {
- pg: "naverpay",
- customer_uid: "gildong_0001_1234", //billing, required.
- merchant_uid: "{Merchant created Order ID}", //Example: order_monthly_0001
- name: "Slim plan (montly)",
- amount: 14000, // For display only, no payment approval
- buyer_email: "iamport@siot.do",
- buyer_name: "Customer name",
- buyer_tel: "010-1234-5678", //Required
- buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
- buyer_postcode: "123-456",
- naverProductCode: "Recurring payment product code",
- naverPopupMode: true, //Enable popup mode
- m_redirect_url: "{URL to redirect to after registration}", //Example: http://yourservice.com/payments/complete
- },
- function (rsp) {
- // callback logic
- //* ...Omitted... *//
- }
-);
-```
+ - Must be specified for subscription/recurring payment registration. If omitted, processed as general payment.
+ - After registration, you can use the key to request recurring payment approval.
-###
+ **`merchant_uid`** **\*** **string**
-### Key parameter description
+ **Order ID**
-**`pg`** **\***\*\* ****s****tring\*\*
+ Must be unique for each request.
-**PG code**
+ **`amount`** **\*** **integer**
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`naverpay`**.
+ **Payment amount**
-**`customer_uid`****`*`****`string`**
+ Must be an integer (not string)
-**`Billing key`**
+ **Payment approval is not processed** **during
+ subscription/recurring payment registration**.
-- Must be specified for subscription/recurring payment registration. If omitted, processed as general payment.
-- After registration, you can use the key to request recurring payment approval.
+ **`naverProductCode`****`*`****`string`**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **Product code managed by the merchant**
-**Order ID**
+ - Used to prevent the same customer from registering duplicate payments for the same product.
+ - The default value is a randomly generated value allowing for duplicate payment registration. To avoid this, specify a value.
-Must be unique for each request.
+ **`name`****`*`****`string`**
-**`amount`** **\***\*\* ****integer\*\*
+ **`Product name`**
-**Payment amount**
+ If multiple products are defined in the `naverProducts` parameter, Naver Pay automatically appends `and 2 others`.
+ Hence, set this to the name of the first product (`naverProducts[0].name`) in the array.
-Must be an integer (not string)
+ **`naverPopupMode`` `****`boolean`**
-**Payment approval is not processed**** during
-subscription/recurring payment registration**.
+ **Option to proceed via popup window**
-**`naverProductCode`****`*`****`string`**
+ - If `false`, payment process will proceed via page redirection and you must specify `m_redirect_url`.
-**Product code managed by the merchant**
+ **`m_redirect_url`****`string`**
-- Used to prevent the same customer from registering duplicate payments for the same product.
-- The default value is a randomly generated value allowing for duplicate payment registration. To avoid this, specify a value.
+ **`Redirect URL`**
-**`name`****`*`****`string`**
+ - URL to redirect to after payment approval when using redirection method (`naverPopupMode`: **false**).
-**`Product name`**
+ ## **Request payment**
-If multiple products are defined in the `naverProducts` parameter, Naver Pay automatically appends `and 2 others`. Hence, set this to the name of the first product (`naverProducts[0].name`) in the array.
+ After getting a billing key, you can request the initial payment or schedule future payment
+ by calling the payment approval API using the registered **`customer_uid`**.
-**` naverPopupMode`` `****`boolean`**
+ ### **How to request payment**
-**Option to proceed via popup window**
+ To request a payment approval, call the REST API [**/subscribe/payments/again**](../../api/api/api).
-- If `false`, payment process will proceed via page redirection and you must specify `m_redirect_url`.
+ - `customer_uid` : `customer_uid` specified for subscription/recurring payment registration.
-**`m_redirect_url`****`string`**
+ - `merchant_uid` : Merchant managed order number.
-**`Redirect URL`**
+ - `amount` : Payment amount (can be different from the amount specified for subscription/recurring payment registration).
-- URL to redirect to after payment approval when using redirection method (`naverPopupMode`: **false**).
+ - `tax_free` : Tax-free amount (out of total `amount`). Default value is 0.
-## **Request payment**
+ - `name` : Order name.
-After getting a billing key, you can request the initial payment or schedule future payment by calling the payment approval API using the registered **`customer_uid`**.
+ - `extra.naverUseCfm` : Expiration date (string in yyyyMMdd format, must be same as the date of payment or later).
+ - Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
-### **How to request payment**
+ ```json title="sample json"
+ {
+ "customer_uid": "gildong_0001_1234",
+ "merchant_uid": "order_monthly_0002", // Cannot be reused
+ "amount": 10000,
+ "name": "Slim plan (initial payment)",
+ "extra": {
+ "naverUseCfm": "20201001"
+ }
+ }
+ ```
-To request a payment approval, call the REST API [**/subscribe/payments/again**](../../api/api/api).
+ ```txt title="form-urlencoded"
+ customer_uid={Unique key to identify the customer}&merchant_uid={Order number}&amount=10000&name=Slim plan (initial payment)&extra[naverUseCfm]=20201001
+ ```
-- `customer_uid` : `customer_uid` specified for subscription/recurring payment registration.
-- `merchant_uid` : Merchant managed order number.
-- `amount` : Payment amount (can be different from the amount specified for subscription/recurring payment registration).
-- `tax_free` : Tax-free amount (out of total `amount`). Default value is 0.
-- `name` : Order name.
-- `extra.naverUseCfm` : Expiration date (string in yyyyMMdd format, must be same as the date of payment or later).
- - Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
+ ### Schedule payments
-```json title="sample json"
-{
- "customer_uid": "gildong_0001_1234",
- "merchant_uid": "order_monthly_0002", // Cannot be reused
- "amount": 10000,
- "name": "Slim plan (initial payment)",
- "extra": {
- "naverUseCfm": "20201001"
- }
-}
-```
+ To schedule payments, call the REST API [**/subscribe/payments/schedule**](../../api/subscription-payment-api/schedule-payment-api).
-```title="form-urlencoded"
-customer_uid={Unique key to identify the customer}&merchant_uid={Order number}&amount=10000&name=Slim plan (initial payment)&extra[naverUseCfm]=20201001
-```
+ - `customer_uid` : `customer_uid` specified for subscription/recurring payment registration.
-###
+ - `schedules` : Payment schedule object array (one or more schedules).
+ - `merchant_uid` : Merchant managed order number.
-### Schedule payments
+ - `schedule_at` : Scheduled time of payment (UNIX timestamp)
-To schedule payments, call the REST API[ **/subscribe/payments/schedule**](../../api/subscription-payment-api/schedule-payment-api).
+ - `amount` : Payment amount (can be different from the amount specified for subscription/recurring payment registration).
-- `customer_uid` : `customer_uid` specified for subscription/recurring payment registration.
-- `schedules` : Payment schedule object array (one or more schedules).
- - `merchant_uid` : Merchant managed order number.
- - `schedule_at` : Scheduled time of payment (UNIX timestamp)
- - `amount` : Payment amount (can be different from the amount specified for subscription/recurring payment registration).
- - `extra.naverUseCfm` : Expiration date (string in yyyyMMdd format, must be same as the date of payment or later).
- - Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
+ - `extra.naverUseCfm` : Expiration date (string in yyyyMMdd format, must be same as the date of payment or later).
+ - Specify if contract between Naver Pay and merchant requires this value for the specified product type (such as music or performance tickets).
-```json title="sample json"
-{
- "customer_uid": "gildong_0001_1234",
- "schedules": [
+ ```json title="sample json"
{
- "merchant_uid": "order_monthly_0003", // Cannot be reused
- "schedule_at": 1519862400,
- "amount": 10000,
- "extra": {
- "naverUseCfm": "20201001"
- }
+ "customer_uid": "gildong_0001_1234",
+ "schedules": [
+ {
+ "merchant_uid": "order_monthly_0003", // Cannot be reused
+ "schedule_at": 1519862400,
+ "amount": 10000,
+ "extra": {
+ "naverUseCfm": "20201001"
+ }
+ }
+ ]
}
- ]
-}
-```
+ ```
-```title="form-urlencoded"
-customer_uid={Unique key to identify the customer}&schedules[0][merchant_uid]={Oder number}&schedules[0][schedule_at]={Scheduled time of payment UNIX timestamp}&schedules[0][amount]=10000&schedules[0][extra][naverUseCfm]=20201001
-```
-
-
+ ```txt title="form-urlencoded"
+ customer_uid={Unique key to identify the customer}&schedules[0][merchant_uid]={Oder number}&schedules[0][schedule_at]={Scheduled time of payment UNIX timestamp}&schedules[0][amount]=10000&schedules[0][extra][naverUseCfm]=20201001
+ ```
+
-### Note
-
-#### Must return error message as-is
+ ### Note
-After calling the payment window (IMP.request_pay), if the payment process is interrupted by clicking the “Cancel” button at the bottom of the payment window, or if payment fails due to reasons such as insufficient balance, exceeding the limit, or less than 100 won, the reason for failure (error_msg) is included in the payment result (response object/query parameter) returned via callback (popup mode) or m_redirect_url (redirect mode). This error message must be returned to the user as it is without processing. If you do not comply with this rule, Naver Pay will request for correction during inspection.
+ #### Must return error message as-is
-Example: Assuming that error_msg is “Insufficient balance”, it should not be returned to the user as “Payment failed. Reason for failure:" + "Insufficient balance".
+ After calling the payment window (IMP.request\_pay),
+ if the payment process is interrupted by clicking the “Cancel” button at the bottom of the payment window,
+ or if payment fails due to reasons such as insufficient balance, exceeding the limit,
+ or less than 100 won, the reason for failure (error\_msg) is included in the payment result (response object/query parameter)
+ returned via callback (popup mode) or m\_redirect\_url (redirect mode).
+ This error message must be returned to the user as it is without processing.
+ If you do not comply with this rule, Naver Pay will request for correction during inspection.
-**Must implement exception handling for payment amount under 100 won**
+ Example: Assuming that error\_msg is “Insufficient balance”,
+ it should not be returned to the user as “Payment failed. Reason for failure:" + "Insufficient balance".
-You must implement exception handling for payment amount less than 100 won, the minimum amount for Naver Pay.
+ **Must implement exception handling for payment amount under 100 won**
-Example: Must return a 'less than minimum amount (100 won)' error message to the user.
+ You must implement exception handling for payment amount less than 100 won,
+ the minimum amount for Naver Pay.
+ Example: Must return a 'less than minimum amount (100 won)' error message to the user.
-
Payment cancellation
+
Payment cancellation
-To call the i'mport cancel payment API `POST` [**`/payments/cancel`**](../../api/payment-api/cancel-payment-api) , you must specify the following parameters. (**If omitted, Naver Pay's inspection will fail**)
+ To call the i'mport cancel payment API `POST` [**`/payments/cancel`**](../../api/payment-api/cancel-payment-api) , you must specify the following parameters. (**If omitted, Naver Pay's inspection will fail**)
-- **`extra.requester`** : API requestor
- - **`customer`**
- - **`admin`**(default)
-- **`reason`**: reason for cancellation
+ - **`extra.requester`** : API requestor
+ - **`customer`**
+ - **`admin`**(default)
-**Example (json)**
+ - **`reason`**: reason for cancellation
-```javascript
-{
- "imp_uid" : "imp_123412341234", // i'mport transaction ID
- "amount" : 3000, // Refund amount
- "reason": "Reson for cancellation", // Must be the actual reason
- "extra" : {
- "requester" : "customer"
- }
-}
-```
+ **Example (json)**
-**Example (form-urlencoded)**
+ ```json
+ {
+ "imp_uid": "imp_123412341234", // i'mport transaction ID
+ "amount": 3000, // Refund amount
+ "reason": "Reson for cancellation", // Must be the actual reason
+ "extra": {
+ "requester": "customer"
+ }
+ }
+ ```
-```
-imp_uid=imp_123412341234&amount=3000&extra[requester]=customer
-```
+ **Example (form-urlencoded)**
+ ```txt
+ imp_uid=imp_123412341234&amount=3000&extra[requester]=customer
+ ```
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/payco.mdx b/src/content/docs/en/payment-integration-by-pg/simple/payco.mdx
index 715a9a48f..6ebd63241 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/payco.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/payco.mdx
@@ -5,157 +5,158 @@ description: PAYCO simple payment integration guide
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure PAYCO simple payment PG settings
+## 1. Configure PAYCO simple payment PG settings
-Refer to the [**PAYCO settings**](../../ready/2.-pg/pg/undefined-3) page to configure the PG settings.
+Refer to the [**PAYCO settings**](../../ready/2.-pg/pg/undefined-3) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'payco',
- merchant_uid: '{Merchant created Order ID}', //Example: order_no_0001
- name : 'Order name: Test payment',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'Customer name',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Samseong-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456'
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
-
-####
-
-### Key parameter description
-
-**`pg`** **\***\*\* ****s****tring\*\*
-
-**PG code**
-
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`payco`**.
-
-**`pay_method`** **s****tring**
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "payco",
+ merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
+ name: "Order name: Test payment",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-**Payment method code**
+ ### Key parameter description
-
-
Payment method codes
+ **`pg`** **\*** **string**
-- `card` (credit card)
-- `trans`(instant account transfer)
-- `vbank`(virtual account)
+ **PG code**
-
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`payco`**.
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **`pay_method`** **string**
-**Order ID**
+ **Payment method code**
-Must be unique for each request.
+
+
Payment method codes
-**`buyer_tel`****`*`****`string`**
+ - `card` (credit card)
+ - `trans`(instant account transfer)
+ - `vbank`(virtual account)
+
-**Customer phone number**
+ **`merchant_uid`** **\*** **string**
-Required
+ **Order ID**
-**`amount`** **\***\*\* ****integer\*\*
+ Must be unique for each request.
-**Payment amount**
+ **`buyer_tel`****`*`****`string`**
-Must be an integer (not string)
+ **Customer phone number**
-
+ Required
-
+ **`amount`** **\*** **integer**
-
-To open subscription payment window, specify the **customer\_uid** parameter.
+ **Payment amount**
-
-**amount**
+ Must be an integer (not string)
-- For display purpose only. No payment approval.
+
+
-
+
+ To open subscription payment window, specify the **customer\_uid** parameter.
-```javascript title="Javascript SDK"
-IMP.request_pay(
- {
- pg: "payco",
- merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
- name: "Order name: Billing key request test",
- amount: 0, // For display purpose only
- customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
- buyer_email: "johndoe@gmail.com",
- buyer_name: "John Doe",
- buyer_tel: "02-1234-1234",
- },
- function (rsp) {
- if (rsp.success) {
- alert("Success");
- } else {
- alert("Failed");
- }
- }
-);
-```
+
+ **amount**
-### Key parameter description
+ - For display purpose only. No payment approval.
+
-**`pg`** **\***\*\* ****s****tring\*\*
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "payco",
+ merchant_uid: "{Merchant created Order ID}", // Example: issue_billingkey_monthly_0001
+ name: "Order name: Billing key request test",
+ amount: 0, // For display purpose only
+ customer_uid: "{Unique ID for the card (billing key)}", // Required (Example: gildong_0001_1234)
+ buyer_email: "johndoe@gmail.com",
+ buyer_name: "John Doe",
+ buyer_tel: "02-1234-1234",
+ },
+ function (rsp) {
+ if (rsp.success) {
+ alert("Success");
+ } else {
+ alert("Failed");
+ }
+ },
+ );
+ ```
-**PG code**
+ ### Key parameter description
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`payco`**.
+ **`pg`** **\*** **string**
-**`customer_uid`** **\***\*\* ****string\*\*
+ **PG code**
-**Credit card billing key**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`payco`**.
-Billing key to be mapped 1:1 with the user-entered credit card information.
+ **`customer_uid`** **\*** **string**
-**`amount`** **\***\*\* ****Integer\*\*
+ **Credit card billing key**
-**Payment amount**
+ Billing key to be mapped 1:1 with the user-entered credit card information.
-For display purpose only. No payment approval.
+ **`amount`** **\*** **Integer**
-### Request payment with billing key (customer_uid)
+ **Payment amount**
-After successfully getting the billing key, the billing key is **stored on the i'mport server** mapped 1:1 with the specified `customer_uid`. For security reasons, the server cannot directly access the billing key. Subsequent payments can be requested by calling the [**non-authenticated payment request REST API**](../../api/api/api) with the `customer_uid` as follows:
+ For display purpose only. No payment approval.
-```title="sever-side"
-curl -H "Content-Type: application/json" \
- -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
- https://api.iamport.kr/subscribe/payments/again
-```
+ ### Request payment with billing key (customer\_uid)
-
+ After successfully getting the billing key, the billing key is **stored on the i'mport server**
+ mapped 1:1 with the specified `customer_uid`.
+ For security reasons, the server cannot directly access the billing key.
+ Subsequent payments can be requested by calling
+ the [**non-authenticated payment request REST API**](../../api/api/api)
+ with the `customer_uid` as follows:
-
-**Not supported.**
+ ```sh title="sever-side"
+ curl -H "Content-Type: application/json" \
+ -X POST -d '{"customer_uid":"your-customer-unique-id", "merchant_uid":"order_id_8237352", "amount":3000}' \
+ https://api.iamport.kr/subscribe/payments/again
+ ```
+
-
+
+ **Not supported.**
+
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/readme.mdx b/src/content/docs/en/payment-integration-by-pg/simple/readme.mdx
index 873d7591f..09cc87ea4 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/readme.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/readme.mdx
@@ -3,4 +3,4 @@ title: Simple payments
description: Learn how to integrate simple payments.
---
-### Learn how to integrate simple payments.
+Learn how to integrate simple payments.
diff --git a/src/content/docs/en/payment-integration-by-pg/simple/toss.mdx b/src/content/docs/en/payment-integration-by-pg/simple/toss.mdx
index d12e0814d..61a94bd2f 100644
--- a/src/content/docs/en/payment-integration-by-pg/simple/toss.mdx
+++ b/src/content/docs/en/payment-integration-by-pg/simple/toss.mdx
@@ -4,86 +4,85 @@ description: Toss simple payment integration guide
---
import Codepen from "~/components/gitbook/Codepen.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-### 1. Configure Toss simple payment PG settings
+## 1. Configure Toss simple payment PG settings
-Refer to the [**Toss simple pay settings**](../../ready/2.-pg/pg/undefined-1) page to configure the PG settings.
+Refer to the [**Toss simple pay settings**](../../ready/2.-pg/pg/undefined-1) page
+to configure the PG settings.
![]()
-### 2. Request payment
+## 2. Request payment
-To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/) IMP.**request_pay**(param, callback).
+To open the payment window, call [JavaScript SDK](../../sdk/javascript-sdk/)
+IMP.**request\_pay**(param, callback).
-In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`. In mobile browsers, the page is redirected to **m_redirect_url**.
+In PC browsers, **callback** is invoked after calling `IMP.request_pay(param, callback)`.
+In mobile browsers, the page is redirected to **m\_redirect\_url**.
-
-```javascript title="Javascript SDK"
-IMP.request_pay({
- pg : 'tosspay',
- pay_method : 'card',
- merchant_uid: '{Merchant created Order ID}', //Example: order_no_0001
- name : 'Order name: Test payment',
- amount : 14000,
- buyer_email : 'iamport@siot.do',
- buyer_name : 'Customer name',
- buyer_tel : '010-1234-5678',
- buyer_addr : 'Samseong-dong, Gangnam-gu, Seoul',
- buyer_postcode : '123-456',
- m_redirect_url : "{URL to redirect to after payment approval}" //Example: http://yourservice.com/payments/complete
-}, function(rsp) { // callback logic
- //* ...Omitted... *//
-});
-```
+
+ ```ts title="Javascript SDK"
+ IMP.request_pay(
+ {
+ pg: "tosspay",
+ pay_method: "card",
+ merchant_uid: "{Merchant created Order ID}", //Example: order_no_0001
+ name: "Order name: Test payment",
+ amount: 14000,
+ buyer_email: "iamport@siot.do",
+ buyer_name: "Customer name",
+ buyer_tel: "010-1234-5678",
+ buyer_addr: "Samseong-dong, Gangnam-gu, Seoul",
+ buyer_postcode: "123-456",
+ m_redirect_url: "{URL to redirect to after payment approval}", //Example: http://yourservice.com/payments/complete
+ },
+ function (rsp) {
+ // callback logic
+ //* ...Omitted... *//
+ },
+ );
+ ```
-####
+ ### Key parameter description
-### Key parameter description
+ **`pg`** **\*** **string**
-**`pg`** **\***\*\* ****s****tring\*\*
+ **PG code**
-**PG code**
+ - If not specified and this is the only PG setting that exists, `default PG` is automatically set.
+ - If there are multiple PG settings, set to **`tosspay`**.
-- If not specified and this is the only PG setting that exists, `default PG` is automatically set.
-- If there are multiple PG settings, set to **`tosspay`**.
+ **`pay_method`** **string**
-**`pay_method`** **s****tring**
+ **Payment method code**
-**Payment method code**
+ - `card` (credit card)
+ - `trans` (instant account transfer)
-- `card` (credit card)
-- `trans` (instant account transfer)
+ **`name`** **\*** **string**
-**`name`** **\***\*\* ****s****tring\*\*
+ **Product name**
-**Product name**
+ **`merchant_uid`** **\*** **string**
-**`merchant_uid`** **\***\*\* ****s****tring\*\*
+ **Order ID**
-**Order ID**
+ Must be unique for each request.
-Must be unique for each request.
+ **`amount`** **\*** **integer**
-**`amount`** **\***\*\* ****integer\*\*
+ **Payment amount**
-**Payment amount**
+ Must be an integer (not string)
-Must be an integer (not string)
-
-
-
-
+
+
-**Toss simple payment is processed in mobile Toss App.**
-
+ **Toss simple payment is processed in mobile Toss App.**
diff --git a/src/content/docs/en/readme.mdx b/src/content/docs/en/readme.mdx
index e0af29e95..d0c269c5f 100644
--- a/src/content/docs/en/readme.mdx
+++ b/src/content/docs/en/readme.mdx
@@ -14,7 +14,7 @@ import Hint from "~/components/Hint.astro";
Read the [Setup](ready/) guide for payment integration guide before proceeding with payment integration.
-### Payment window integration
+## Payment window integration
You can easily integrate your payment window by following these guides.
@@ -24,13 +24,13 @@ You can easily integrate your payment window by following these guides.
-### Ensuring payment result notification
+## Ensuring payment result notification
Learn how to use i'mport webhook, a stable and reliable method for receiving payment results.
-### Other service integrations
+## Other service integrations
Learn how to integrate other useful services to your site.
@@ -44,7 +44,7 @@ Learn how to integrate other useful services to your site.
-### Tips
+## Tips
Make sure to check these useful tips about payment integration.
@@ -62,29 +62,29 @@ Make sure to check these useful tips about payment integration.
-### Admin console
+## Admin console
Learn how to use the Admin console.
-### API
+## API
i'mport API specification
-### SDK
+## SDK
Payment integration JS SDK specification
-### FAQ
+## FAQ
-### **Payment integration guides by PG**
+## **Payment integration guides by PG**
diff --git a/src/content/docs/en/readme/get-started.mdx b/src/content/docs/en/readme/get-started.mdx
index dc0739b90..920dbe61b 100644
--- a/src/content/docs/en/readme/get-started.mdx
+++ b/src/content/docs/en/readme/get-started.mdx
@@ -5,20 +5,23 @@ description: Learn about i'mport online payments.
import Figure from "~/components/Figure.astro";
-### i'mport provides payment window integration through JavaScript SDK so that anyone can easily implement complex PG payment integration specifications.
+## i'mport provides payment window integration through JavaScript SDK so that anyone can easily implement complex PG payment integration specifications.
- Simply add the library with 2 lines of code to complete the setup for payment window integration.
-- Easily integrate the payment window using the JavaScript SDK that most developers are familiar with.
+
+- Easily integrate the payment window using the JavaScript SDK
+ that most developers are familiar with.
-### Changes to PGs and payment methods are also processed simply by changing the relevant parameter values.
+## Changes to PGs and payment methods are also processed simply by changing the relevant parameter values.
-- You can easily add and change payment methods and PGs by modifying the JavaScript input parameters.
+- You can easily add and change payment methods and PGs
+ by modifying the JavaScript input parameters.
-### We provide all payment references and integration samples and guides for various programming languages in sync with the latest trends.
+## We provide all payment references and integration samples and guides for various programming languages in sync with the latest trends.
- JAVA
- PHP
@@ -28,12 +31,9 @@ import Figure from "~/components/Figure.astro";
- Golang
- ...
-
+
-### All payment data is protected in real time through monitoring so that you can use it with confidence.
+## All payment data is protected in real time through monitoring so that you can use it with confidence.
- Encryption of all payment data
- Blocking of any attempts to forge/falsify payment data
@@ -41,18 +41,22 @@ import Figure from "~/components/Figure.astro";
![]()
-### By storing payment progress cycles in real time, you can accurately analyze the reason and cause of payment failures.
+## By storing payment progress cycles in real time, you can accurately analyze the reason and cause of payment failures.
- When payment widow is active
- When payment window is closed by the user
- When payment is complete
-### You can easily cancel payments for any PG payment method.
+## You can easily cancel payments for any PG payment method.
+
+- Regardless of the payment method, you can use the same cancellation API
+ to cancel any PG payment transaction.
-- Regardless of the payment method, you can use the same cancellation API to cancel any PG payment transaction.
- We support full and partial cancellations.
-- You no longer have to waste development resources for implementing specific cancellation integration for each payment method.
-### i'mport offers three value propositions.
+- You no longer have to waste development resources
+ for implementing specific cancellation integration for each payment method.
+
+## i'mport offers three value propositions.
diff --git a/src/content/docs/en/ready/1.mdx b/src/content/docs/en/ready/1.mdx
index 87ed30712..24df062d2 100644
--- a/src/content/docs/en/ready/1.mdx
+++ b/src/content/docs/en/ready/1.mdx
@@ -7,19 +7,17 @@ import Details from "~/components/gitbook/Details.astro";
import Hint from "~/components/Hint.astro";
-For payment integration, you must first create an account from the i'mport Admin [**Sign Up**](https://admin.iamport.kr) page.
-
-You can sign up for **free without a contract**.
+ For payment integration, you must first create an account from the i'mport Admin [**Sign Up**](https://admin.iamport.kr) page.
+ You can sign up for **free without a contract**.
-
Create an i'mport account now
-
-Just need to provide your "**email address"**.
+
Create an i'mport account now
-Use a “**strong password**" to protect it from unauthorized access.
+ Just need to provide your "**email address"**.
+ Use a “**strong password**" to protect it from unauthorized access.
Click **Sign up** from the pages below to create an account.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/daou.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/daou.mdx
index eede8a162..979e5d012 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/daou.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/daou.mdx
@@ -4,141 +4,127 @@ description: Learn how to set up Daou.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
+
+ ### **Test environment setup**
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA** -> **Add**
-2. Check the auto-generated Merchant ID/Key/MID values and click **Save**
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA** -> **Add**
+ 2. Check the auto-generated Merchant ID/Key/MID values and click **Save**
-
+
-
+
+
-
+
+ ### Live environment setup
-
-### Live environment setup
+ 1. **Payment integration -> Live settings**
+ 2. Select PG (**PAYJOA**) → **PAYJOA** -> **Add**
+ 3. Enter merchant info issued by Daou upon contract signing.
-1. **Payment integration -> Live settings**
-2. Select PG (**PAYJOA**) → **PAYJOA** -> **Add**
-3. Enter merchant info issued by Daou upon contract signing.
+
-
+
-
+
-
+
+ ### **Checklist**
-
-### **Checklist**
+ - Must request MID for the correct **product type** (physical/digital).
+ - **Payment integration key** is required for payment cancellation.
+
-- Must request MID for the correct **product type** (physical/digital).
-- **Payment integration key** is required for payment cancellation.
+ ### \[PAYJOA Admin console settings]
-
+ Configure the following settings to **successfully receive payment result**.
-###
+ 1. Log in to the [PAYJOA Admin page](https://agent.kiwoompay.co.kr/)
-### \[PAYJOA Admin console settings]
+ 2. At the top of the page, click **Customer support** > **Integration settings**
-Configure the following settings to **successfully receive payment result**.
+ ![]()
-1. Log in to the [PAYJOA Admin page](https://agent.kiwoompay.co.kr/)
-2. At the top of the page, click **Customer support** > **Integration settings**
+ 3. In the integration settings page, select the **CPID** at the bottom and then click **Edit**
-![]()
+
-3\. In the integration settings page, select the **CPID** at the bottom and then click **Edit**
+ 4. For each contracted payment method, set the **Notification URL**
-
+ > [https://service.iamport.kr/daou\_payments/result](https://service.iamport.kr/daou_payments/result)
-4\. For each contracted payment method, set the **Notification URL**
-
-> [https://service.iamport.kr/daou_payments/result](https://service.iamport.kr/daou_payments/result)
-
-![]()
-
-
+ ![]()
+
## Non-authenticated payment
-
-### Subscription test environment setup
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
-2. **Select 'Subscription** test CTS17266' **Edit -> Save**
-
-
-
-
-
-###
-
-### Key-in (one-time) test environment setup
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
-2. **Select 'Key-in** test CTS16629' **Edit -> Save**
-
-
-
-
+
+ ### Subscription test environment setup
-
-### **Test key-in payment with different required parameters**
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
+ 2. **Select 'Subscription** test CTS17266' **Edit -> Save**
-You can test by setting different required parameters by CPID.
+
-- **Credit card number + password + expiration date + date of birth**
+
- \- CPID : **CTS16629**
+ ### Key-in (one-time) test environment setup
- \- Secret : 7f59ab6239259b191e2806111734c17c4650301ae0f241d2939c747176b4f6aa
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
+ 2. **Select 'Key-in** test CTS16629' **Edit -> Save**
-- **Credit card number + expiration date**
+
- \- CPID : **CTS16628**
+
- \- Secret : 9e810e78e4d8ac765f8f04f1f3132da0c4891a2c04f6ee5a142bc333070b68a9
+
+ ### **Test key-in payment with different required parameters**
-
+ You can test by setting different required parameters by CPID.
-
-### **Checklist**
+ - **Credit card number + password + expiration date + date of birth**
-- PAYJOA's subscription payment supports only the REST API method.
-- In test mode, actual withdrawal occurs but is automatically cancelled daily between 23:00 and 23:50.
-- Note that the test Merchant ID for **key-in** (one-time) and **subscription** payments are different.
-- Must request MID for the correct **product type** (physical/digital).
+ - CPID : **CTS16629**
+ - Secret : 7f59ab6239259b191e2806111734c17c4650301ae0f241d2939c747176b4f6aa
-
+ - **Credit card number + expiration date**
-###
+ - CPID : **CTS16628**
+ - Secret : 9e810e78e4d8ac765f8f04f1f3132da0c4891a2c04f6ee5a142bc333070b68a9
+
-### Subscription/key-in payment production environment setup
+
+ ### **Checklist**
-1. **Payment integration -> Live settings**
-2. Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
-3. Enter merchant info issued by Daou upon contract signing
+ - PAYJOA's subscription payment supports only the REST API method.
+ - In test mode, actual withdrawal occurs but is automatically cancelled daily between 23:00 and 23:50.
+ - Note that the test Merchant ID for **key-in** (one-time) and **subscription** payments are different.
+ - Must request MID for the correct **product type** (physical/digital).
+
-
+ ### Subscription/key-in payment production environment setup
-
+ 1. **Payment integration -> Live settings**
+ 2. Select PG (**PAYJOA**) → **PAYJOA API** -> **Add**
+ 3. Enter merchant info issued by Daou upon contract signing
-
+
-
+
-
-**Not supported**
+
+
-
+
+ **Not supported**
+
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/jtnet.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/jtnet.mdx
index 687e58788..a9572c2a5 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/jtnet.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/jtnet.mdx
@@ -3,117 +3,108 @@ title: JTNET 설정
description: JTNET PG사 설정 방법을 확인합니다.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 JTNet(tPay) 선택 → 테스트모드 \[ON] → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 JTNet(tPay) 선택 → 테스트모드 \[ON] → \[전체 저장] 클릭
-
-**테스트MID 정보**
+
+ **테스트MID 정보**
-- MID : tpaytest0m
-- Secret 키 : VXFVMIZGqUJx29I/k52vMM8XG4hizkNfiapAkHHFxq0RwFzPit55D3J3sAeFSrLuOnLNVCIsXXkcBfYK1wv8kQ==
-- 취소비밀번호 : 123456
+ - MID : tpaytest0m
+ - Secret 키 : VXFVMIZGqUJx29I/k52vMM8XG4hizkNfiapAkHHFxq0RwFzPit55D3J3sAeFSrLuOnLNVCIsXXkcBfYK1wv8kQ==
+ - 취소비밀번호 : 123456
+
-
+ ![]()
+
-![]()
+
+ ### **실** 환경 구성방법
-
+ 카드사 심사 완료 후 JTNet에서 발급받은 실상점 정보를 \*\*테스트모드 \*\***OFF** 처리 이후 설정합니다.
-
-### **실** 환경 구성방법
-
-카드사 심사 완료 후 JTNet에서 발급받은 실상점 정보를 **테스트모드 ****OFF** 처리 이후 설정합니다.
-
-![]()
-
-
+ ![]()
+
## 비 인증 결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 JTNet(tPay) 선택 → **테스트모드 \[OFF]** → 아래의 상점정보 직접 입력 → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 JTNet(tPay) 선택 → **테스트모드 \[OFF]** → 아래의 상점정보 직접 입력 → \[전체 저장] 클릭
-
-**테스트MID 정보**
+
+ **테스트MID 정보**
-- PG상점아이디(MID) : tpaytest2m
-- PG상점 Secret : coqTx/Taxu9W6dlKPhFuciagoVXr/14ezgoK9+qJCf4bBuo23iRGGWHS4rHIuOSgZ6I/uizX39W/NygDplUYOA==
-- 결제취소 비밀번호 : 1234
+ - PG상점아이디(MID) : tpaytest2m
+ - PG상점 Secret : coqTx/Taxu9W6dlKPhFuciagoVXr/14ezgoK9+qJCf4bBuo23iRGGWHS4rHIuOSgZ6I/uizX39W/NygDplUYOA==
+ - 결제취소 비밀번호 : 1234
+
-
+ ![]()
-![]()
+ ### **실** 환경 구성방법
-### **실** 환경 구성방법
+ 카드사 심사 완료 후 JTNet에서 발급받은 실상점 정보를 **설정합니다.**
-카드사 심사 완료 후 JTNet에서 발급받은 실상점 정보를 **설정합니다.**
+ ![]()
+
-![]()
+
+ ### 테스트 환경 구성방법(키인결제)
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 JTNet(tPay) 선택 → **카드사 심사 전 개발용 계정 설정** 선택-> \[전체 저장] 클릭
-
-### 테스트 환경 구성방법(키인결제)
+
+ **테스트MID 정보(키인결제용도)**
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 JTNet(tPay) 선택 → **카드사 심사 전 개발용 계정 설정** 선택-> \[전체 저장] 클릭
+ - MID : tpaytest1m
+ - Secret 키 : hgEY70BdDgoJYVOwj5CHsRDQt5a6IieQLQv+Q2rA6nnW+wXP57fH2ZkvUBJW0c9/eF1Rp5QRZ+qjzJ+Knc8r1A==
+ - 취소비밀번호 : 123456
+
-
-**테스트MID 정보(키인결제용도)**
-
-- MID : tpaytest1m
-- Secret 키 : hgEY70BdDgoJYVOwj5CHsRDQt5a6IieQLQv+Q2rA6nnW+wXP57fH2ZkvUBJW0c9/eF1Rp5QRZ+qjzJ+Knc8r1A==
-- 취소비밀번호 : 123456
-
-
-
-![]()
+ ![]()
-### 실 환경 구성방법(키인결제)
+ ### 실 환경 구성방법(키인결제)
-카드사 심사 완료 후 JTNet 에서 발급받은 실상점 정보를 설정합니다.
+ 카드사 심사 완료 후 JTNet 에서 발급받은 실상점 정보를 설정합니다.
-![]()
+ ![]()
-### 테스트 환경 구성방법(**정기결제**)
+ ### 테스트 환경 구성방법(**정기결제**)
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 JTNet(tPay키인결제) 선택 → 아래의 상점정보 직접 입력 → \[저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 JTNet(tPay키인결제) 선택 → 아래의 상점정보 직접 입력 → \[저장] 클릭
-
-**테스트MID 정보(정기결)**
-
-- PG상점아이디 : tpaytest2m
-- PG상점 Secret : coqTx/Taxu9W6dlKPhFuciagoVXr/14ezgoK9+qJCf4bBuo23iRGGWHS4rHIuOSgZ6I/uizX39W/NygDplUYOA==
-- 결제취소비밀번호 : 1234
+
+ **테스트MID 정보(정기결)**
-
+ - PG상점아이디 : tpaytest2m
+ - PG상점 Secret : coqTx/Taxu9W6dlKPhFuciagoVXr/14ezgoK9+qJCf4bBuo23iRGGWHS4rHIuOSgZ6I/uizX39W/NygDplUYOA==
+ - 결제취소비밀번호 : 1234
+
-![]()
+ ![]()
-### 실 환경 구성방법(정기결제)
+ ### 실 환경 구성방법(정기결제)
-카드사 심사 완료 후 JTNet 에서 발급받은 실상점 정보를 설정합니다.
+ 카드사 심사 완료 후 JTNet 에서 발급받은 실상점 정보를 설정합니다.
-![]()
-
-
+ ![]()
+
-### **체크사항**
-
-JTNet 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
+ ### **체크사항**
+ JTNet 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/kg.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/kg.mdx
index 4485d09ef..7d452bd4f 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/kg.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/kg.mdx
@@ -4,30 +4,28 @@ description: KG모빌리언스 설정방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/) → 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 모빌리언스 선택 → **테스트모드 \[ON]** → **서비스 ID** 에 **170622040674** 입력 → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/) → 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 모빌리언스 선택 → **테스트모드 \[ON]** → **서비스 ID** 에 **170622040674** 입력 → \[전체 저장] 클릭
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ PG사 심사 완료 후 KG모빌리언스에서 발급받은 실상점 정보를 **테스트모드 OFF** 이후 설정합니다.
-PG사 심사 완료 후 KG모빌리언스에서 발급받은 실상점 정보를 **테스트모드 OFF** 이후 설정합니다.
-
-
-
-
+
+
## 비 인증 결제
@@ -35,17 +33,15 @@ PG사 심사 완료 후 KG모빌리언스에서 발급받은 실상점 정보를
> **KG모빌리언스 비 인증 결제는 휴대폰 결제만 지원합니다.**
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 모빌리언스 선택 → **테스트모드 \[ON]** → **서비스 ID** 에 '**170622040674**' 입력 → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 모빌리언스 선택 → **테스트모드 \[ON]** → **서비스 ID** 에 '**170622040674**' 입력 → \[전체 저장] 클릭
-
-
-
+
+
-**KG모빌리언스 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.**
-
+ **KG모빌리언스 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.**
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/kicc.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/kicc.mdx
index aaa226e0f..78d156d69 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/kicc.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/kicc.mdx
@@ -4,77 +4,72 @@ description: Learn how to set up KICC.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KICC**) → **KICC** -> **Add**
-2. Check the auto-generated test MID value and click **Save**
+
+ ### **Test environment setup**
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KICC**) → **KICC** -> **Add**
+ 2. Check the auto-generated test MID value and click **Save**
-
+
-
+
+
-
-### Live environment setup
+
+ ### Live environment setup
-1. **Payment integration -> Live settings**
-2. Select PG (**KICC**) → **KICC** -> **Add**
-3. Enter merchant info issued by KICC upon approval by the credit card company.
+ 1. **Payment integration -> Live settings**
+ 2. Select PG (**KICC**) → **KICC** -> **Add**
+ 3. Enter merchant info issued by KICC upon approval by the credit card company.
-
+
-
+
-
-
-
+
+
## Non-authenticated payment
-
-### Test environment setup
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KICC**) → **KICC** -> **Add**
-2. Check the auto-generated MID value and then click **Save**.
+
+ ### Test environment setup
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KICC**) → **KICC** -> **Add**
+ 2. Check the auto-generated MID value and then click **Save**.
-
+
-### Live environment setup
+
-1. **Payment integration -> Live settings**
-2. **KICC -> KICC -> Add**
-3. Enter **MID** issued at contract signing -> **Save**
+ ### Live environment setup
-
+ 1. **Payment integration -> Live settings**
+ 2. **KICC -> KICC -> Add**
+ 3. Enter **MID** issued at contract signing -> **Save**
-
+
-
+
-
+
+
-
-**Not supported.**
-
-
+
+ **Not supported.**
+
-**Note**
-
-In KICC test mode, no money is actually withdrawn.
+ **Note**
+ In KICC test mode, no money is actually withdrawn.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp-1.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp-1.mdx
index 45a63ca2a..3cd706083 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp-1.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp-1.mdx
@@ -4,101 +4,93 @@ description: Learn how to set up KG INICIS.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
+
+ ### **Test environment setup**
-1. [i'mport Admin console](https://admin.iamport.kr) → **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS** -> **Add**
-2. Select **General payment test INIpayTest Settings** -> **Save**
+ 1. [i'mport Admin console](https://admin.iamport.kr) → **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS** -> **Add**
+ 2. Select **General payment test INIpayTest Settings** -> **Save**
-> A payment is made on the i'mport test account.
+ > A payment is made on the i'mport test account.
-
+
-
+
-
-**KG INICIS PG Merchant ID (MID) : INIpayTest**
-
-
+
+ **KG INICIS PG Merchant ID (MID) : INIpayTest**
+
+
-
+
+ ### Live environment setup
-
-### Live environment setup
+ 1. **Payment integration -> Live settings**
+ 2. **KG INICIS -> KG INICIS -> Add**
+ 3. Enter **MID** issued at contract signing.
-1. **Payment integration -> Live settings**
-2. **KG INICIS -> KG INICIS -> Add**
-3. Enter **MID** issued at contract signing.
+
-
+
-
-
-
-
-
+
+
## Non-authenticated payment
-- To get a KG INICIS **API billing key**, you must first check service entry possibility through the PG. In most cases, **'payment window method'** is supported but '**API method**' service entry conditions are stringent due to PG's policy.
-- **Foreign credit cards are not supported.**
-
+ - To get a KG INICIS **API billing key**, you must first check service entry possibility through the PG. In most cases, **'payment window method'** is supported but '**API method**' service entry conditions are stringent due to PG's policy.
+ - **Foreign credit cards are not supported.**
-
-### Test environment setup
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS** -> **Add**
-2. **Subscription payment test `INIBillTst` Settings ->** **Save**
-
-
-
-
+
+ ### Test environment setup
-### Live environment setup
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS** -> **Add**
+ 2. **Subscription payment test `INIBillTst` Settings -> Save**
-1. **Payment integration -> Live settings**
-2. **KG INICIS -> KG INICIS -> Add**
-3. Enter **MID** issued at contract signing. (**MID for billing is required)**
+
-
+
-
+ ### Live environment setup
-
+ 1. **Payment integration -> Live settings**
+ 2. **KG INICIS -> KG INICIS -> Add**
+ 3. Enter **MID** issued at contract signing. (**MID for billing is required)**
-
+
-
-### Test environment setup
+
-[i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS API** -> **Add**
+
+
-
+
+ ### Test environment setup
-###
+ [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**KG INICIS**) → **KG INICIS API** -> **Add**
-### Live environment setup
+
-1. **Payment integration -> Live settings**
-2. **KG INICIS -> ****KG INICIS API**** -> Add**
-3. Enter **MID** issued at contract signing.
+ ### Live environment setup
-
+ 1. **Payment integration -> Live settings**
+ 2. **KG INICIS -> ****KG INICIS API**** -> Add**
+ 3. Enter **MID** issued at contract signing.
-
+
-
+
-
+
+
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp.mdx
index 91a7b17a7..022eb2cae 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nhn-kcp.mdx
@@ -4,35 +4,35 @@ description: Learn how to set up NHN KCP.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
+
+ ### **Test environment setup**
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP** -> **Add**
-2. Select **General payment test T0000 Settings** -> **Save**
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP** -> **Add**
+ 2. Select **General payment test T0000 Settings** -> **Save**
-> A payment is made on the i'mport test account.
+ > A payment is made on the i'mport test account.
-
+
-
+
+
-
+
+ ### Live environment setup
-
-### Live environment setup
+ Enter the **Site Code** and **Site Key** issued by KCP using the **Add** button and then click **Save**.
-Enter the **Site Code** and **Site Key** issued by KCP using the **Add** button and then click **Save**.
+
-
-
-
+
+
## Non-authenticated payment
@@ -41,84 +41,78 @@ Since non-authenticated payment has more stringent conditions for service entry
payment, you must first check service entry possibility with KCP.
-
-### Test environment setup
+
+ ### Test environment setup
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP (Subscription)** -> **Add**
-2. Check the auto-generated MID value and then click **Save**.
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP (Subscription)** -> **Add**
+ 2. Check the auto-generated MID value and then click **Save**.
-
+
-
+
-### Live environment setup
+ ### Live environment setup
-Enter the live **Site Code** issued by KCP at contract signing as follows:
+ Enter the live **Site Code** issued by KCP at contract signing as follows:
-1. **Payment integration -> Live settings**
-2. **NHN KCP -> NHN KCP(Subscription) -> Add**
-3. **Enter Site Code, Site Key, and Batch Payment Group ID -> Save**
+ 1. **Payment integration -> Live settings**
+ 2. **NHN KCP -> NHN KCP(Subscription) -> Add**
+ 3. **Enter Site Code, Site Key, and Batch Payment Group ID -> Save**
-
-**How to get a Batch Payment Group ID** \
-Log in to the KCP merchant admin page with the **site code issued by KCP for subscription payments**, enter a desired user name and a password to get a private certificate.\
- \- To get a certificate: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with subscription payment ID > Customer service > Certificate issuance > KCP private certificate > Click Request NHN KCP certificate > Confirm Username (random input)\
- \- To get a group ID: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with subscription payment ID > Payments > **General payment > Credit card** **> Batch payment ID >** Get group ID
+
+ **How to get a Batch Payment Group ID** \
+ Log in to the KCP merchant admin page with the **site code issued by KCP for subscription payments**, enter a desired user name and a password to get a private certificate.\
+ \- To get a certificate: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with subscription payment ID > Customer service > Certificate issuance > KCP private certificate > Click Request NHN KCP certificate > Confirm Username (random input)\
+ \- To get a group ID: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with subscription payment ID > Payments > **General payment > Credit card > Batch payment ID >** Get group ID
+
-
+
-
+
-
+
+
-
+
+ ### Test environment setup
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP API** -> **Add**
+ 2. Check the auto-generated MID value and then click **Save**.
-
-### Test environment setup
+
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NHN KCP**) → **NHN KCP API** -> **Add**
-2. Check the auto-generated MID value and then click **Save**.
+
-
+ ### Live environment setup
-
+ Enter the **Site Code** and **Site Key** issued by KCP at contract signing as follows:
-### Live environment setup
+ 1. **Payment integration -> Live settings**
+ 2. **NHN KCP -> NHN KCP API -> Add**
+ 3. **Enter Site Code (PG Merchant ID) and Site Key (PG Merchant Secret), and then enter Batch Payment Group ID -> Save**
-Enter the **Site Code** and **Site Key** issued by KCP at contract signing as follows:
+
+ **How to get a Batch Payment Group ID** \
+ Log in to the KCP merchant admin page with the **site code issued by KCP for recurring payments**, and then enter a desired user name and a password to get a private certificate.\
+ \- To get a certificate: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with recurring payment ID > Customer service > Certificate issuance > KCP private certificate > Click Request NHN KCP certificate > Confirm Username (random input)\
+ \- To get a group ID: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with recurring payment ID > Payments > **General payment > Credit card > Batch payment ID >** Get group ID
+
-1. **Payment integration -> Live settings**
-2. **NHN KCP -> NHN KCP API -> Add**
-3. **Enter Site Code (PG Merchant ID) and Site Key (PG Merchant Secret), and then enter Batch Payment Group ID -> Save**
+
-
-**How to get a Batch Payment Group ID** \
-Log in to the KCP merchant admin page with the **site code issued by KCP for recurring payments**, and then enter a desired user name and a password to get a private certificate.\
- \- To get a certificate: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with recurring payment ID > Customer service > Certificate issuance > KCP private certificate > Click Request NHN KCP certificate > Confirm Username (random input)\
- \- To get a group ID: [https://admin8.kcp.co.kr](https://admin8.kcp.co.kr/) > Log in with recurring payment ID > Payments > **General payment > Credit card** **> Batch payment ID >** Get group ID
+
-
-
-
-
-
-
-
-
-
+
+
-**Since non-authenticated payment has more stringent conditions for service entry than general payment, you must first check service entry possibility with KCP.**
-
+ **Since non-authenticated payment has more stringent conditions for service entry than general payment, you must first check service entry possibility with KCP.**
-## Checklist
-
-- In test mode, no money withdrawl occurs for a payment.
-- Hub-type Kakao Pay and Naver Pay do not support test mode. (Service is available after contract signing with KCP)
+ ## Checklist
+ - In test mode, no money withdrawl occurs for a payment.
+ - Hub-type Kakao Pay and Naver Pay do not support test mode. (Service is available after contract signing with KCP)
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nice-payments.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nice-payments.mdx
index 9f97c19ae..92e33e997 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/nice-payments.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/nice-payments.mdx
@@ -4,60 +4,56 @@ description: Learn how to set up NICE Payments.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NICE Payments**) → **NICE Payments** -> **Add**
-2. Check the auto-generated test MID value and click **Save**
-
-> A payment is made on the i'mport test MID account.
+
+ ### **Test environment setup**
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NICE Payments**) → **NICE Payments** -> **Add**
+ 2. Check the auto-generated test MID value and click **Save**
-
+ > A payment is made on the i'mport test MID account.
-In NICE Payments test mode, the following payment methods are **not supported**.
+
-- Credit card: NH card, KB Kookmin card
-- Mobile micropayments: KT
+
-
-**Payments made in NICE Payments test mode are cancelled daily between 23:00\~23:50.**
+ In NICE Payments test mode, the following payment methods are **not supported**.
-Since cancelled transactions are not automatically reflected in i'mport, it is recommended that you submit a cancellation request after testing.
+ - Credit card: NH card, KB Kookmin card
+ - Mobile micropayments: KT
-
+
+ **Payments made in NICE Payments test mode are cancelled daily between 23:00\~23:50.**
-
+ Since cancelled transactions are not automatically reflected in i'mport, it is recommended that you submit a cancellation request after testing.
+
+
-
-### Live environment setup
+
+ ### Live environment setup
-1. **Payment integration -> Live settings**
-2. Select PG (**NICE Payments**) → **NICE Payments** -> **Add**
-3. Enter merchant info issued by NICE Payments upon approval by the credit card company.
+ 1. **Payment integration -> Live settings**
+ 2. Select PG (**NICE Payments**) → **NICE Payments** -> **Add**
+ 3. Enter merchant info issued by NICE Payments upon approval by the credit card company.
-
+
-
+
-
+
-
-**Precautions when using virtual accounts**
+
+ **Precautions when using virtual accounts**
-You must log in to the NICE Payments Admin page and set the **virtual account deposit notification URL**. (If omitted, deposit will not be applied.)
-
-
-
-
+ You must log in to the NICE Payments Admin page and set the **virtual account deposit notification URL**. (If omitted, deposit will not be applied.)
+
+
## Non-authenticated payment
@@ -65,30 +61,26 @@ You must log in to the NICE Payments Admin page and set the **virtual account de
i'mport currently **only supports API method** for NICE Payments non-authenticated payments.
-
-### **Test environment setup**
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NICE Payments**) → **NICE Payments API** -> **Add**
-2. Check the auto-generated test MID value and click **Save**
+
+ ### **Test environment setup**
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**NICE Payments**) → **NICE Payments API** -> **Add**
+ 2. Check the auto-generated test MID value and click **Save**
-
+
-###
+
-### Live environment setup
+ ### Live environment setup
-- **Payment integration -> Live settings**
-- Select PG (**NICE Payments**) → **NICE Payments API** -> **Add**
-- Enter merchant info issued by NICE Payments upon approval by the credit card company
+ - **Payment integration -> Live settings**
+ - Select PG (**NICE Payments**) → **NICE Payments API** -> **Add**
+ - Enter merchant info issued by NICE Payments upon approval by the credit card company
-
+
-
+
-
-
-
+
+
-
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/readme.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/readme.mdx
index 674272698..04babc744 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/readme.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/readme.mdx
@@ -5,7 +5,7 @@ description: Learn how to configure settings for each PG supported by i'mport.
import ContentRef from "~/components/gitbook/ContentRef.astro";
-### Use the following instructions to set up each PG for payment integration from the i'mport Admin page.
+## Use the following instructions to set up each PG for payment integration from the i'mport Admin page.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-1.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-1.mdx
index ff4a3663b..159881e02 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-1.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-1.mdx
@@ -4,9 +4,9 @@ description: Learn how to set up Paymentwall.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
import image3 from "./_assets/paymentwall/paymentwall.pingback.country_code.png";
import image1 from "./_assets/paymentwall/paymentwall.tab.widget.png";
@@ -101,7 +101,7 @@ as a pingback parameter.
You can check this result by adding the `extension=true` query parameter when querying payment.
-```jsx
+```http
GET http://api.iamport.kr/payments/{imp_uid}?extension=true
```
@@ -111,8 +111,8 @@ GET http://api.iamport.kr/payments/{imp_uid}?extension=true
"vbank_name": null,
"vbank_num": null,
"extension": {
- "country_code": "KR", // User Country Code(alpha-2)
- // ...
+ "country_code": "KR", // User Country Code(alpha-2)
+ // ...
}
}
```
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-2.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-2.mdx
index dc88c3621..ae278f08f 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-2.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-2.mdx
@@ -4,217 +4,146 @@ description: 다날 PG사 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증**결제**
-
-**테스트 환경 구성방법**
-
-1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** 선택 → **추가**
-2. 자동으로 기재되는 CPID 정보 확인 후 **저장**
+
+ **테스트 환경 구성방법**
-
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** 선택 → **추가**
+ 2. 자동으로 기재되는 CPID 정보 확인 후 **저장**
-
+
-
+
+
-
-**실 환경 구성방법**
+
+ **실 환경 구성방법**
-1. [포트원 관리자 콘솔](https://admin.portone.io/)→ **결제 연동 → 실 연동 관리 선택**
-2. **다날 → ****다날**** 선택 → 추가**
-3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보 기재 후 저장
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/)→ **결제 연동 → 실 연동 관리 선택**
+ 2. **다날 → ****다날**** 선택 → 추가**
+ 3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보 기재 후 저장
-
+
-
+
-
-
-
+
+
## 비 인증 결제
-
-**테스트 환경 구성방법**
-
-1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** 선택 → **추가**
-2. 자동으로 기재되는 CPID 정보 확인 후 **저장**
+
+ **테스트 환경 구성방법**
-
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** 선택 → **추가**
+ 2. 자동으로 기재되는 CPID 정보 확인 후 **저장**
-
+
-**실 환경 구성방법**
+
-1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
-2. **다날 → ****다날**** 선택 → 추가**
-3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보 기재 후 저장
+ **실 환경 구성방법**
-
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
+ 2. **다날 → ****다날**** 선택 → 추가**
+ 3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보 기재 후 저장
-
+
-
+
-
+
+
-
-**다날은 ****API**** 를 통한 비인증 결제를 지원하지 않습니다.** :cry:
-
-
+
+ **다날은 ****API**** 를 통한 비인증 결제를 지원하지 않습니다.** :cry:
+
## 휴대폰 소액결제
-
-**테스트 환경 구성방법**
-
-- [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** **휴대폰결제** 선택 → **추가**
-- 자동으로 기재되는 CPID 정보 확인 후 **저장**
+
+ **테스트 환경 구성방법**
-
-**다날 휴대폰결제 테스트용 CPID : A010002002**
+ - [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** **휴대폰결제** 선택 → **추가**
+ - 자동으로 기재되는 CPID 정보 확인 후 **저장**
-
-
-
-
-
+
+ **다날 휴대폰결제 테스트용 CPID : A010002002**
+
-
+
-
-**실 환경 구성방법**
+
+
-1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
-2. **다날** → **다날** **휴대폰결제** 선택 → **추가**
-3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보로 기재후 저장
+
+ **실 환경 구성방법**
-
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
+ 2. **다날** → **다날** **휴대폰결제** 선택 → **추가**
+ 3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보로 기재후 저장
-
+
-
+
-
+
+
## SMS 본인인증
-
-**테스트 환경 구성방법**
+
+ **테스트 환경 구성방법**
-- [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** **SMS 본인인증** 선택 → **추가**
-- 다날 계약 후 발급받은 CPID 정보를 기재 후 **저장**
+ - [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동** → **테스트 연동 관리** → **다날** → **다날** **SMS 본인인증** 선택 → **추가**
+ - 다날 계약 후 발급받은 CPID 정보를 기재 후 **저장**
-
-**다날 SMS 본인인증**
+
+ **다날 SMS 본인인증**
-휴대폰 SMS 본인인증은 테스트는 별도의 테스트 전용 CPID 정보를 제공하지 않습니다.
+ 휴대폰 SMS 본인인증은 테스트는 별도의 테스트 전용 CPID 정보를 제공하지 않습니다.
-테스트 진행을 위해서는 다날 계약이후 발급받은 정보로만 가능합니다.
+ 테스트 진행을 위해서는 다날 계약이후 발급받은 정보로만 가능합니다.
+
-
+
-
+
+
-
+
+ **실 환경 구성방법**
-
+ 1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
+ 2. **다날** → **다날** **휴대폰결제** 선택 → **추가**
+ 3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보로 기재후 저장
-
-**실 환경 구성방법**
+
-1. [포트원 관리자 콘솔](https://admin.portone.io/) → **결제 연동 → 실 연동 관리 선택**
-2. **다날** → **다날** **휴대폰결제** 선택 → **추가**
-3. 카드사 심사 완료 후 다날에서 발급받은 실상점 정보로 기재후 저장
+
-
-
-
-
-
-
-
+
+
-**특이사항**
-
-- 다날은 하나의 상점ID(CPID)에 인증/비 인증 결제 셋팅이 가능합니다.
-- 테스트 모드의 경우 실제로 결제승인이 이루어지지만, PG사에서 일괄적으로 매일 자정이전 자동 취소가 이루어집니다.
-- 다날 정책상 계좌이체/가상계좌는 테스트 결제가 제공되지 않습니다. 계약 후 실제 상점아이디로 테스트를 해야 합니다
-- SMS 본인인증은 통신사 정책으로 인하여 테스트 모드 이용이 불가합니다. (실 계약 후 이용가능)
-- 테스트 모드에서 부분취소 테스트는 불가합니다.
+ **특이사항**
+ - 다날은 하나의 상점ID(CPID)에 인증/비 인증 결제 셋팅이 가능합니다.
+ - 테스트 모드의 경우 실제로 결제승인이 이루어지지만, PG사에서 일괄적으로 매일 자정이전 자동 취소가 이루어집니다.
+ - 다날 정책상 계좌이체/가상계좌는 테스트 결제가 제공되지 않습니다. 계약 후 실제 상점아이디로 테스트를 해야 합니다
+ - SMS 본인인증은 통신사 정책으로 인하여 테스트 모드 이용이 불가합니다. (실 계약 후 이용가능)
+ - 테스트 모드에서 부분취소 테스트는 불가합니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-3.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-3.mdx
index 1ca542ff9..3d5947e70 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-3.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-3.mdx
@@ -3,66 +3,61 @@ title: 세틀뱅크 설정
description: 세틀뱅크 설정방법을 안내합니다.
---
-import ContentRef from "~/components/gitbook/ContentRef.astro";
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import ContentRef from "~/components/gitbook/ContentRef.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 세틀뱅크 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 세틀뱅크 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ 카드사 심사 완료 후 세틀뱅크에서 발급받은 실상점 정보를 **테스트모드 OFF** 처리 이후 설정합니다.
-카드사 심사 완료 후 세틀뱅크에서 발급받은 실상점 정보를 **테스트모드 OFF** 처리 이후 설정합니다.
-
-
-
-
+
+
## 비 인증 결제
-
-#### **세틀뱅크의 정기결제는 ****REST API 방식****만 지원합니다.**
-
-
+
+ 세틀뱅크의 정기결제는 **REST API 방식**만 지원합니다.
+
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 세틀뱅크 선택 → \[**카드사 심사 전 개발용 계정 설정**] 클릭 → \[저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**정기결제 및 키인결제**) → PG사 세틀뱅크 선택 → \[**카드사 심사 전 개발용 계정 설정**] 클릭 → \[저장] 클릭
-
+
-### **실** 환경 구성방법
+ ### **실** 환경 구성방법
-카드사 심사 완료 후 세틀뱅크에서 발급받은 실상점 정보를 설정합니다.
+ 카드사 심사 완료 후 세틀뱅크에서 발급받은 실상점 정보를 설정합니다.
-### 가상계좌 연동 방법
+ ### 가상계좌 연동 방법
-아래 링크를 참조하여 가상계좌 발급 및 취소 API 를 연동합니다.
+ 아래 링크를 참조하여 가상계좌 발급 및 취소 API 를 연동합니다.
-
-
-
+
+
-### **체크사항**
-
-- 세틀뱅크 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
-- 세틀뱅크는 가상계좌 발급을 API방식으로 지원합니다.
+ ### **체크사항**
+ - 세틀뱅크 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
+ - 세틀뱅크는 가상계좌 발급을 API방식으로 지원합니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-4.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-4.mdx
index 4789aa1d2..ed24baf62 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-4.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-4.mdx
@@ -4,35 +4,32 @@ description: 스마트로 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 스마트로 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 스마트로 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ 카드사 심사 완료 후 스마트로에서 발급받은 실상점 정보를 설정 합니다.
-카드사 심사 완료 후 스마트로에서 발급받은 실상점 정보를 설정 합니다.
-
-
-
-
+
+
-**비 인증 결제**
-
-아임포트는 스마트로 비 인증 결제를 지원하지 않습니다.
+ **비 인증 결제**
+ 아임포트는 스마트로 비 인증 결제를 지원하지 않습니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-5.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-5.mdx
index e4b07129b..a7387af17 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-5.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-5.mdx
@@ -4,98 +4,94 @@ description: 페이팔 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-> - 페이팔 테스트 환경 구성을 위해서는 **아임포트 관리자 페이지 설정**과 **페이팔 관리자페이지 설정**이 각각 적용되어야 합니다.
-> - 페이팔은 별도의 계약없이 판매자 계정만 생성하면 바로 서비스 이용이 가능합니다.
+ > - 페이팔 테스트 환경 구성을 위해서는 **아임포트 관리자 페이지 설정**과 **페이팔 관리자페이지 설정**이 각각 적용되어야 합니다.
+ > - 페이팔은 별도의 계약없이 판매자 계정만 생성하면 바로 서비스 이용이 가능합니다.
-### **아임포트 관리자 콘솔 설정**
+ ### **아임포트 관리자 콘솔 설정**
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 페이팔-Express Checkout 선택 → **테스트모드 \[ON]** → API 사용자 정보 입력 → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 페이팔-Express Checkout 선택 → **테스트모드 \[ON]** → API 사용자 정보 입력 → \[전체 저장] 클릭
-![]()
+ ![]()
-
-**Email 계정주소 설정시 주의사항**
+
+ **Email 계정주소 설정시 주의사항**
-자동완성된 Email 주소가 **실제 페이팔 계정 ID와 상이한 경우** **실 계정 ID 로 수정**하여 저장해야 합니다.
+ 자동완성된 Email 주소가 **실제 페이팔 계정 ID와 상이한 경우** **실 계정 ID 로 수정**하여 저장해야 합니다.
+
-
+ ### **페이팔 관리자 콘솔 설정**
-### **페이팔 관리자 콘솔 설정**
+ #### **판매자 Sandbox 계정 설정**
-#### **판매자 Sandbox 계정 설정**
+ 1. [https://developer.paypal.com/developer/accounts/](https://developer.paypal.com/developer/accounts/) 로그인 > **SANDBOX** > **Accounts** > DEFAULT Business 계정의 \[**View/edit account**] 클릭
-1. [https://developer.paypal.com/developer/accounts/](https://developer.paypal.com/developer/accounts/) 로그인 > **SANDBOX** > **Accounts** > DEFAULT Business 계정의 \[**View/edit account**] 클릭
+
-
+ **2. Account details 팝업창**
-**2. Account details 팝업창**
+ API Credentials 탭의 Username, Password, 및 Signature 값을 아임포트 관리자 콘솔 페이팔 설정 항목에 아래와 같이 맵핑합니다.
-API Credentials 탭의 Username, Password, 및 Signature 값을 아임포트 관리자 콘솔 페이팔 설정 항목에 아래와 같이 맵핑합니다.
+ - Username = API 사용자 이름
+ - Password = API 암호
+ - Signature = 서명
-- Username = API 사용자 이름
-- Password = API 암호
-- Signature = 서명
+
-
+ **구매자 Sandbox 계정 설정**
-**구매자 Sandbox 계정 설정**
+ 1. [https://developer.paypal.com/developer/accounts/](https://developer.paypal.com/developer/accounts/) 로그인 > **SANDBOX** > **Accounts** > DEFAULT Personal 계정의 \[**View/edit account**] 클릭
-1. [https://developer.paypal.com/developer/accounts/](https://developer.paypal.com/developer/accounts/) 로그인 > **SANDBOX** > **Accounts** > DEFAULT Personal 계정의 \[**View/edit account**] 클릭
+
-
+ **2. Account details 팝업창**
-**2. Account details 팝업창**
+ Profile 탭의 **Email ID** 및 **Password** 값을 페이팔 결제시 구매자 로그인 계정정보로 사용합니다.
-Profile 탭의 **Email ID** 및 **Password** 값을 페이팔 결제시 구매자 로그인 계정정보로 사용합니다.
+ ![]()
+
-![]()
+
+ ### **실** 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 페이팔-Express Checkout 선택 → **테스트모드 \[OFF]** → API 사용자 정보 입력 → \[전체 저장] 클릭
-
-### **실** 환경 구성방법
+ ![]()
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 페이팔-Express Checkout 선택 → **테스트모드 \[OFF]** → API 사용자 정보 입력 → \[전체 저장] 클릭
+ > **각 항목별 실 운영 정보 값은 페이팔 관리자 페이지에서 아래 절차를 통해 확인합니다.**
-![]()
+ 1. [https://www.paypal.com/](https://www.paypal.com/) 로그인 > 계정 클릭 > 계정 설정 클릭 > "계정 엑세스" 클릭 > "**API 엑세스**"의 업데이트 클릭
-> **각 항목별 실 운영 정보 값은 페이팔 관리자 페이지에서 아래 절차를 통해 확인합니다.**
+ ![]()
-1. [https://www.paypal.com/](https://www.paypal.com/) 로그인 > 계정 클릭 > 계정 설정 클릭 > "계정 엑세스" 클릭 > "**API 엑세스**"의 업데이트 클릭
+ **2) NVP/SOAP API 통합(클래식) 의 API 자격증명 관리 클릭**
-![]()
+ \- 참고 : 휴대폰본인인증 절차 필요
-**2) NVP/SOAP API 통합(클래식) 의 API 자격증명 관리 클릭**
+ ![]()
-\- 참고 : 휴대폰본인인증 절차 필요
+ **3) API 서명보기 "표시" 클릭**
-![]()
-
-**3) API 서명보기 "표시" 클릭**
-
-- API 사용자 이름
-- API 비밀번호
-- 서명
-
-
+ - API 사용자 이름
+ - API 비밀번호
+ - 서명
+
-### **참고사항**
-
-- Business 계정이 Sandbox이면 구매자 계정도 Sandbox Accounts 목록에 존재하는 Personal 계정으로 결제(사용)해야 합니다.
-- Sandbox Accounts 의 Country 가 "US"인 Personal 계정으로 테스트해야 합니다. **판매자와 구매자 계정 국가가 "한국"인 경우 페이팔 정책상 결제가 불가**하며, **판매자는 한국이고 구매자가 미국인 경우는 가능**합니다.
-- 판매자와 구매자 계정 국가가 "한국"인 경우 페이팔 정책상 결제가 불가합니다. 판매자와 구매자 중 최소 한사람의 국가가 해외여야 합니다
-- 아임포트는 페이팔 정기결제를 지원하지 않습니다.
+ ### **참고사항**
+ - Business 계정이 Sandbox이면 구매자 계정도 Sandbox Accounts 목록에 존재하는 Personal 계정으로 결제(사용)해야 합니다.
+ - Sandbox Accounts 의 Country 가 "US"인 Personal 계정으로 테스트해야 합니다. **판매자와 구매자 계정 국가가 "한국"인 경우 페이팔 정책상 결제가 불가**하며, **판매자는 한국이고 구매자가 미국인 경우는 가능**합니다.
+ - 판매자와 구매자 계정 국가가 "한국"인 경우 페이팔 정책상 결제가 불가합니다. 판매자와 구매자 중 최소 한사람의 국가가 해외여야 합니다
+ - 아임포트는 페이팔 정기결제를 지원하지 않습니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-6.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-6.mdx
index cdb092c0d..d84f82dee 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-6.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-6.mdx
@@ -4,39 +4,36 @@ description: 엑심베이 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 엑심베이 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 엑심베이 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭
-> - 엑심베이 테스트 모드의 경우 결제시 실제 출금이 이루어지지 않습니다.
-> - 테스트모드의 경우 테스트용 카드를 사용해주셔야 하며 해외에서 발급받으신 실제 카드를 사용하실 경우 오류가 발생됩니다.
-> - [엑심베이에서 제공하는 해외결제용 테스트 카드 확인하기](https://support.eximbay.com/hc/ko/articles/360059014854-%EA%B2%B0%EC%A0%9C%ED%85%8C%EC%8A%A4%ED%8A%B8%EB%A5%BC-%EC%A7%84%ED%96%89%ED%95%B4%EB%B3%B4%EA%B3%A0-%EC%8B%B6%EC%9D%80%EB%8D%B0-%ED%95%B4%EC%99%B8%EC%B9%B4%EB%93%9C%EA%B0%80-%EC%97%86%EC%8A%B5%EB%8B%88%EB%8B%A4-%EC%96%B4%EB%96%BB%EA%B2%8C-%ED%95%A0-%EC%88%98-%EC%9E%88%EB%82%98%EC%9A%94-)
+ > - 엑심베이 테스트 모드의 경우 결제시 실제 출금이 이루어지지 않습니다.
+ > - 테스트모드의 경우 테스트용 카드를 사용해주셔야 하며 해외에서 발급받으신 실제 카드를 사용하실 경우 오류가 발생됩니다.
+ > - [엑심베이에서 제공하는 해외결제용 테스트 카드 확인하기](https://support.eximbay.com/hc/ko/articles/360059014854-%EA%B2%B0%EC%A0%9C%ED%85%8C%EC%8A%A4%ED%8A%B8%EB%A5%BC-%EC%A7%84%ED%96%89%ED%95%B4%EB%B3%B4%EA%B3%A0-%EC%8B%B6%EC%9D%80%EB%8D%B0-%ED%95%B4%EC%99%B8%EC%B9%B4%EB%93%9C%EA%B0%80-%EC%97%86%EC%8A%B5%EB%8B%88%EB%8B%A4-%EC%96%B4%EB%96%BB%EA%B2%8C-%ED%95%A0-%EC%88%98-%EC%9E%88%EB%82%98%EC%9A%94-)
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ 카드사 심사 완료 후 엑심베이에서 발급받은 실 상점 정보를 **테스트 모드 OFF** 설정후 해당 값을 입력합니다.
-카드사 심사 완료 후 엑심베이에서 발급받은 실 상점 정보를 **테스트 모드 OFF** 설정후 해당 값을 입력합니다.
-
-![]()
-
-
+ ![]()
+
-### **참고사항**
-
-아임포트는 엑심베이 비 인증 결제 방식을 지원하지 않습니다.
+ ### **참고사항**
+ 아임포트는 엑심베이 비 인증 결제 방식을 지원하지 않습니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-7.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-7.mdx
index 493962b0d..ab61c3943 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-7.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined-7.mdx
@@ -4,35 +4,32 @@ description: 블루월넛 설정방법을 확인합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 인증결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 블루월넛 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭\
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 블루월넛 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭\\
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ 카드사 심사 완료 후 블루월넛에서 발급받은 실 상점 정보를 **테스트 모드 OFF** 설정후 해당 값을 입력합니다.
-카드사 심사 완료 후 블루월넛에서 발급받은 실 상점 정보를 **테스트 모드 OFF** 설정후 해당 값을 입력합니다.
-
-
-
-
+
+
-### 참고사항
-
-아임포트는 블루월넛 비 인증 결제를 지원하지 않습니다.
+ ### 참고사항
+ 아임포트는 블루월넛 비 인증 결제를 지원하지 않습니다.
diff --git a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined.mdx b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined.mdx
index c2548d2d1..6a89dd00d 100644
--- a/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined.mdx
+++ b/src/content/docs/en/ready/2-pg/payment-gateway-settings/undefined.mdx
@@ -4,58 +4,53 @@ description: Learn how to set up Toss Payments.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Authenticated payment
-
-### **Test environment setup**
-
-1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**Toss Payments**) → **(Prev) Toss Payments** -> **Add**
-2. Check the auto-generated test MID value and click **Save**
-
-
+
+ ### **Test environment setup**
-
+ 1. [i'mport Admin console](https://admin.iamport.kr)→ **Payment integration** → **Test settings** → Select PG (**Toss Payments**) → **(Prev) Toss Payments** -> **Add**
+ 2. Check the auto-generated test MID value and click **Save**
-
-**Note - Authenticated payment module information**
-
-The Toss Payments authenticated payment method provided by i'mport uses the **previous module** integration method and is planned for upgrade to the new module. From merchants' perspective, there is no difference in terms of service between the old and new modules.
-
-
+
-
+
-
-### Live environment setup
+
+ **Note - Authenticated payment module information**
-- **Payment integration -> Live settings**
-- Select PG (**Toss Payments**) → **Toss Payments** -> **Add**
-- Enter merchant info (MID/MertKey) issued by Toss Payments upon contract signing.
+ The Toss Payments authenticated payment method provided by i'mport uses the **previous module** integration method and is planned for upgrade to the new module. From merchants' perspective, there is no difference in terms of service between the old and new modules.
+
+
-
-Request MID for the previous module
+
+ ### Live environment setup
-For Toss Payments authenticated payment through i'mport, you must request for the **previous authenticated payment module method** when requesting for authenticated payment MID to obtain the correct MID.
+ - **Payment integration -> Live settings**
+ - Select PG (**Toss Payments**) → **Toss Payments** -> **Add**
+ - Enter merchant info (MID/MertKey) issued by Toss Payments upon contract signing.
-
+
+ Request MID for the previous module
-
+ For Toss Payments authenticated payment through i'mport, you must request for the **previous authenticated payment module method** when requesting for authenticated payment MID to obtain the correct MID.
+
-
+
-
+
-
+
+
-**Note - How to apply for non-authenticated payment**
-
-To use Toss Payments non-authenticated payment, [**sing up from the i'mport Admin**](https://admin.iamport.kr) and request for the service by sending your **account ID** (email address) to cs@iamport.kr.
+ **Note - How to apply for non-authenticated payment**
+ To use Toss Payments non-authenticated payment, [**sing up from the i'mport Admin**](https://admin.iamport.kr) and request for the service by sending your **account ID** (email address) to [cs@iamport.kr](mailto:cs@iamport.kr).
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined-1.mdx b/src/content/docs/en/ready/2-pg/pg/undefined-1.mdx
index ba5b15edb..92920b448 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined-1.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined-1.mdx
@@ -4,36 +4,33 @@ description: 토스 간편결제 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 일반**결제**
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]토스 선택 → **테스트모드 \[ON]** → 테스트 apikey 입력 > \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]토스 선택 → **테스트모드 \[ON]** → 테스트 apikey 입력 > \[전체 저장] 클릭
-> - 테스트 상점아이디 : **tosstest**
-> - 테스트 apiKey : **sk\_test\_w5lNQylNqa5lNQe013Nq**
+ > - 테스트 상점아이디 : **tosstest**
+ > - 테스트 apiKey : **sk\_test\_w5lNQylNqa5lNQe013Nq**
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ \*\*테스트모드 \*\***OFF** 처리 이후 카드사 심사 완료 후 토스페이에서 발급받은 실상점 정보로 설정 해야 합니다.
-**테스트모드 ****OFF** 처리 이후 카드사 심사 완료 후 토스페이에서 발급받은 실상점 정보로 설정 해야 합니다.
-
-
-
-
+
+
-**아임포트는 토스 간편결제 정기결제를 지원하지 않습니다.**
-
+ **아임포트는 토스 간편결제 정기결제를 지원하지 않습니다.**
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined-2.mdx b/src/content/docs/en/ready/2-pg/pg/undefined-2.mdx
index fcab7667d..55f31d9be 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined-2.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined-2.mdx
@@ -4,37 +4,34 @@ description: 네이버페이(결제형) PG설정 방법을 안내합니다.
---
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-**네이버페이는 테스트 연동정보를 별도로 제공하지 않습니다. 가입신청 후 연동정보를 받아서 테스트 모드로 연동/개발 할 수 있습니다.**
-
+ **네이버페이는 테스트 연동정보를 별도로 제공하지 않습니다. 가입신청 후 연동정보를 받아서 테스트 모드로 연동/개발 할 수 있습니다.**
## 일반**결제**
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제네이버페이(결제) 선택 → 테스트모드 \[ON] → **발급받은 상점정보 입력** → \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제네이버페이(결제) 선택 → 테스트모드 \[ON] → **발급받은 상점정보 입력** → \[전체 저장] 클릭
-- **파트너아이디** : 네이버페이 결제형 파트너ID 입력
-- **클라이언트 ID** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
-- **클라이언트 SECRET** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
+ - **파트너아이디** : 네이버페이 결제형 파트너ID 입력
+ - **클라이언트 ID** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
+ - **클라이언트 SECRET** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
-![]()
+ ![]()
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
-
-**테스트모드 OFF** 설정(네이버페이 실 검수가 시작되면 OFF 설정)
-
-
+ **테스트모드 OFF** 설정(네이버페이 실 검수가 시작되면 OFF 설정)
+
## 정기결제
@@ -42,71 +39,68 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
### 네이버페 정기결제는 결제창 방식만 지원합니다.
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제네이버페이(결제) 선택 → 테스트모드 \[ON] → **발급받은 상점정보 입력** → \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-- **파트너아이디** : 네이버페이 결제형 파트너ID 입력
-- **클라이언트 ID** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
-- **클라이언트 SECRET** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제네이버페이(결제) 선택 → 테스트모드 \[ON] → **발급받은 상점정보 입력** → \[전체 저장] 클릭
-![]()
+ - **파트너아이디** : 네이버페이 결제형 파트너ID 입력
+ - **클라이언트 ID** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
+ - **클라이언트 SECRET** : 네이버페이측에서 카드사 심사 완료시 고객사로 직접 안내됨
-### 실 환경 구성방법
+ ![]()
-**테스트모드 OFF** 설정(네이버페이 실 검수가 시작되면 OFF 설정)
+ ### 실 환경 구성방법
-
+ **테스트모드 OFF** 설정(네이버페이 실 검수가 시작되면 OFF 설정)
+
-#### **네이버페이 검수란?**
-
-네이버페이 결제형 오픈을 위해서는 네이버페이 검수팀으로 부터 기술검수 통과가 진행되어야 합니다. 해당 검수는 **필수**적으로 진행되어야 하며 해당 검수는 모든 연동이 완료된 이후 당사로 검수요청을 주시면 아임포트 1차 검토 이후 이상이 없는 경우 네이버페이로 실 검수 요청하는 프로세스로 진행됩니다.
+ #### **네이버페이 검수란?**
+ 네이버페이 결제형 오픈을 위해서는 네이버페이 검수팀으로 부터 기술검수 통과가 진행되어야 합니다. 해당 검수는 **필수**적으로 진행되어야 하며 해당 검수는 모든 연동이 완료된 이후 당사로 검수요청을 주시면 아임포트 1차 검토 이후 이상이 없는 경우 네이버페이로 실 검수 요청하는 프로세스로 진행됩니다.
-
네이버페이 기술검수 요청 방법
-
-네이버페이 기술검수를 위해서는 아래 질문리스트를 작성하여 아래 이메일 주소로 검수요청을 주시면 됩니다.
-
-```
-<사업자 및 계약정보>
- - 상호명 :
- - 사업자번호 :
- - 아임포트계정 :
- - 네이버페이 결제형 파트너ID : 단건/반복(정기) 이용하실 방식 구분하여 전달 주시기 바랍니다.
- - 검수 진행가능한 URL :
- - 테스트 가능한 로그인계정 :
- - 네이버페이 결제형 연동 개발자 정보(이름/이메일/전화번호):
+
네이버페이 기술검수 요청 방법
+
+ 네이버페이 기술검수를 위해서는 아래 질문리스트를 작성하여 아래 이메일 주소로 검수요청을 주시면 됩니다.
+
+ ```md
+ <사업자 및 계약정보>
+ - 상호명 :
+ - 사업자번호 :
+ - 아임포트계정 :
+ - 네이버페이 결제형 파트너ID : 단건/반복(정기) 이용하실 방식 구분하여 전달 주시기 바랍니다.
+ - 검수 진행가능한 URL :
+ - 테스트 가능한 로그인계정 :
+ - 네이버페이 결제형 연동 개발자 정보(이름/이메일/전화번호):
- 네이버페이 결제형 연동 검수 담당자 정보(이름/이메일/전화번호):
- - 판매상품 과/면세 여부:
- - 에스크로 사용여부:
- - 모바일앱 보유 여부:
- - 부분취소 제공여부:
+ - 판매상품 과/면세 여부:
+ - 에스크로 사용여부:
+ - 모바일앱 보유 여부:
+ - 부분취소 제공여부:
- IMP.request_pay 함수 호출 시 naverProducts 파라미터 설정여부 및 셋팅 예시:
-<질의사항>
-1. 일반결제만 연동하는 경우
- 1) 지원하는 PC 웹 브라우저 종류와 최소 버전:
- 2) 지원하는 모바일 웹 브라우저 종류와 최소 버전:
- (앱으로만 연동하시는 경우, 지원하는 모바일 OS 종류와 최소 버전: (ex. iOS 12.0.1, Android 8.0))
- 3) 네이버페이 계약 시, 현금영수증 발급을 누가 하도록 결정하셨나요?
- 4) 네이버페이 계약 시, 포인트 적립 방식은 자동지급방식으로 계약하셨나요? 직접 건별로 지급하기로 계약하셨나요?
-
-2. 일반 + 정기결제 모두 연동하는 경우
- 1) 지원하는 PC 웹 브라우저 종류와 최소 버전:
- 2) 지원하는 모바일 웹 브라우저 종류와 최소 버전:
- (앱으로만 연동하시는 경우, 지원하는 모바일 OS 종류와 최소 버전: (ex. iOS 12.0.1, Android 8.0))
- 3) 네이버페이 계약 시, 현금영수증 발급을 누가 하도록 결정하셨나요?
- 4) 네이버페이 계약 시, 포인트 적립 방식은 자동지급방식으로 계약하셨나요? 직접 건별로 지급하기로 계약하셨나요?
- 5) 정기결제 등록 내역 조회를 어떤 방식으로 구현하시고 계신가요? 예) 관리자페이지 반복결제내역 조회 시 / 자체주문 생성 시 정보조회
- 6) 결제 내역 조회를 어떤 방식으로 구현하시고 계신가요? 예) 관리자페이지 결제내역 조회 시 / 자체주문 생성 시 정보조회 / 정산 대사 작업 배치
- 7) 어떤 경우에 정기결제가 해제되나요? 예) 등록생성 실패 시 / 등록된 반복결제항목 해제 시 / 관리자 반복결제 등록항목 해제
-```
-
-**email : support@iamport.kr**
-
+ <질의사항>
+ 1. 일반결제만 연동하는 경우
+ 1) 지원하는 PC 웹 브라우저 종류와 최소 버전:
+ 2) 지원하는 모바일 웹 브라우저 종류와 최소 버전:
+ (앱으로만 연동하시는 경우, 지원하는 모바일 OS 종류와 최소 버전: (ex. iOS 12.0.1, Android 8.0))
+ 3) 네이버페이 계약 시, 현금영수증 발급을 누가 하도록 결정하셨나요?
+ 4) 네이버페이 계약 시, 포인트 적립 방식은 자동지급방식으로 계약하셨나요? 직접 건별로 지급하기로 계약하셨나요?
+
+ 2. 일반 + 정기결제 모두 연동하는 경우
+ 1) 지원하는 PC 웹 브라우저 종류와 최소 버전:
+ 2) 지원하는 모바일 웹 브라우저 종류와 최소 버전:
+ (앱으로만 연동하시는 경우, 지원하는 모바일 OS 종류와 최소 버전: (ex. iOS 12.0.1, Android 8.0))
+ 3) 네이버페이 계약 시, 현금영수증 발급을 누가 하도록 결정하셨나요?
+ 4) 네이버페이 계약 시, 포인트 적립 방식은 자동지급방식으로 계약하셨나요? 직접 건별로 지급하기로 계약하셨나요?
+ 5) 정기결제 등록 내역 조회를 어떤 방식으로 구현하시고 계신가요? 예) 관리자페이지 반복결제내역 조회 시 / 자체주문 생성 시 정보조회
+ 6) 결제 내역 조회를 어떤 방식으로 구현하시고 계신가요? 예) 관리자페이지 결제내역 조회 시 / 자체주문 생성 시 정보조회 / 정산 대사 작업 배치
+ 7) 어떤 경우에 정기결제가 해제되나요? 예) 등록생성 실패 시 / 등록된 반복결제항목 해제 시 / 관리자 반복결제 등록항목 해제
+ ```
+
+ **email : [support@iamport.kr](mailto:support@iamport.kr)**
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined-3.mdx b/src/content/docs/en/ready/2-pg/pg/undefined-3.mdx
index 6469daffc..7690ba2f3 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined-3.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined-3.mdx
@@ -4,11 +4,11 @@ description: 페이코 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-#### 페이코 결제 테스트를 위해서는 아래 애플리케이션을 다운로드 받으셔야 합니다.
+**페이코 결제 테스트를 위해서는 아래 애플리케이션을 다운로드 받으셔야 합니다.**
> - URL : [https://devcenter.payco.com](https://devcenter.payco.com/)
> - 로그인(ID/PW) : payco / payco1234
@@ -17,54 +17,49 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
## 인증결제
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]페이코 선택 → **테스트모드\[ON]** 클릭 → \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]페이코 선택 → **테스트모드\[ON]** 클릭 → \[전체 저장] 클릭
-
+
+
-
-### **실** 환경 구성방법
+
+ ### **실** 환경 구성방법
-카드사 심사 완료 후 페이코에서 발급받은 실상점 정보를 설정합니다.
+ 카드사 심사 완료 후 페이코에서 발급받은 실상점 정보를 설정합니다.
-
-
-
+
+
## 정기 결제
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]페이코 선택 → 테스트모드 \[ON] → '**PAYCO정기결제(자동결제) 테스트용도인가요?**' 체크박스 선택 > \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]페이코 선택 → 테스트모드 \[ON] → '**PAYCO정기결제(자동결제) 테스트용도인가요?**' 체크박스 선택 > \[전체 저장] 클릭
-### **실** 환경 구성방법
+
-카드사 심사 완료 후 페이코에서 발급받은 실상점 정보를 **테스트모드 OFF** 처리후 설정합니다.
+ ### **실** 환경 구성방법
-
+ 카드사 심사 완료 후 페이코에서 발급받은 실상점 정보를 **테스트모드 OFF** 처리후 설정합니다.
-
+
+
-
-#### **페이코 정기결제는 ****결제창 방식****만 지원합니다.**
-
-
+
+ #### 페이코 정기결제는 **결제창 방식**만 지원합니다.
+
-### **확인사항**
-
-- 페이코 테스트 모드의 경우 실 결제가 이루어지지 않습니다.
-- 테스트 환경에서는 결제한도 등의 테스트는 불가합니다.
-- 페이코 테스트는 상용앱을 지운 후 테스트 앱으로 진행해야 합니다.
+ ### **확인사항**
+ - 페이코 테스트 모드의 경우 실 결제가 이루어지지 않습니다.
+ - 테스트 환경에서는 결제한도 등의 테스트는 불가합니다.
+ - 페이코 테스트는 상용앱을 지운 후 테스트 앱으로 진행해야 합니다.
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined-4.mdx b/src/content/docs/en/ready/2-pg/pg/undefined-4.mdx
index ab2b64e7a..b031fbbf6 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined-4.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined-4.mdx
@@ -4,15 +4,15 @@ description: 차이 간편결제 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-#### 차이 결제 테스트를 위해서는 아래 애플리케이션을 다운로드 받으셔야 합니다.
+차이 결제 테스트를 위해서는 아래 애플리케이션을 다운로드 받으셔야 합니다.
> - Android : [https://appdistribution.firebase.dev/i/8fef29de1f667252](https://appdistribution.firebase.dev/i/8fef29de1f667252)◦
>
-> \- **staging 앱**을 설치
+> \- **staging 앱**을 설치
>
> - iOS : [https://testflight.apple.com/join/ZgQIFce5](https://testflight.apple.com/join/ZgQIFce5)
>
@@ -21,73 +21,67 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
> \- 앱의 오른쪽 엣지에서 왼쪽으로 swipe 후 **staging 설정**
-**테스트 계좌 안내**
-
-**정상 응답 계좌**
+ **테스트 계좌 안내**
-- 국민은행 : 201602181111
-- 우리은행 : 201602182222
-- 경남은행 : 201602183333
+ **정상 응답 계좌**
-**잔액 부족 계좌**
+ - 국민은행 : 201602181111
+ - 우리은행 : 201602182222
+ - 경남은행 : 201602183333
-- 국민은행 : 772210258507
-- 신한은행 : 110438106449
-- 경남은행 : 629220095451
+ **잔액 부족 계좌**
+ - 국민은행 : 772210258507
+ - 신한은행 : 110438106449
+ - 경남은행 : 629220095451
## 일반 결제
-
-### 테스트 환경 구성방법
+
+ ### 테스트 환경 구성방법
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[ON]** → public_api_key 및 private_api_key에 발급받은 키 정보 입력 > \[전체 저장] 클릭
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[ON]** → public\_api\_key 및 private\_api\_key에 발급받은 키 정보 입력 > \[전체 저장] 클릭
-> **차이간편결제 테스트를 진행하기 위해서는 차이 가입 이후 발급된 정보로만 테스트가 가능합니다.**
+ > **차이간편결제 테스트를 진행하기 위해서는 차이 가입 이후 발급된 정보로만 테스트가 가능합니다.**
-
+
+
-
+
+ ### **실** 환경 구성방법
-
-### **실** 환경 구성방법
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[OFF]** → public\_api\_key 및 private\_api\_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[OFF]** → public_api_key 및 private_api_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
-
-
-
-
+
+
## 정기 결제
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[ON]** → public_api_key 및 private_api_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[ON]** → public\_api\_key 및 private\_api\_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
-### **실** 환경 구성방법
+
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[OFF]** → public_api_key 및 private_api_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
+ ### **실** 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제] 차이 선택 → **테스트모드 \[OFF]** → public\_api\_key 및 private\_api\_key 에 발급받은 키 정보 입력 > \[전체 저장] 클릭
-
+
+
-
-**차이 간편결제는 API 방식을 통한 정기결제는 지원하지 않습니다.**
-
-
+
+ **차이 간편결제는 API 방식을 통한 정기결제는 지원하지 않습니다.**
+
-#### **확인사항**
-
-차이 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
+ #### **확인사항**
+ 차이 테스트 모드의 경우 실제 출금 되지만 매일 23:00\~23:50분 사이 자동 취소됩니다.
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined-5.mdx b/src/content/docs/en/ready/2-pg/pg/undefined-5.mdx
index 7976b2f8b..639f8a229 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined-5.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined-5.mdx
@@ -4,27 +4,25 @@ description: 알리페이 설정 방법을 안내합니다.
---
import Figure from "~/components/Figure.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
-### 아임포트를 통한 알리페이 결제는 나이스페이먼츠 서비스를 이용합니다.
+아임포트를 통한 알리페이 결제는 나이스페이먼츠 서비스를 이용합니다.
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 알리페이(Alipay) 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭\
-
-
+
+ ## 테스트 환경 구성방법
-
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 알리페이(Alipay) 선택 → **테스트모드 \[ON]** → \[전체 저장] 클릭\\
-
-### **실** 환경 구성방법
+
+
-카드사 심사 완료 후 NICE페이먼츠 에서 발급받은 실상점 정보를 **테스트 모드 OFF** 이후 설정합니다.
+
+ ## **실** 환경 구성방법
-
+ 카드사 심사 완료 후 NICE페이먼츠 에서 발급받은 실상점 정보를 **테스트 모드 OFF** 이후 설정합니다.
-
+
+
diff --git a/src/content/docs/en/ready/2-pg/pg/undefined.mdx b/src/content/docs/en/ready/2-pg/pg/undefined.mdx
index e1354f2d6..4a411c5ca 100644
--- a/src/content/docs/en/ready/2-pg/pg/undefined.mdx
+++ b/src/content/docs/en/ready/2-pg/pg/undefined.mdx
@@ -3,29 +3,27 @@ title: 카카오페이 설정
description: 카카오페이 간편결제 설정 방법을 확인합니다.
---
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
## 일반**결제**
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]카카오페이 선택 → 테스트모드 \[ON] → 고객사코드(CID)에 **TC0ONETIME** 입력 > \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-![]()
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]카카오페이 선택 → 테스트모드 \[ON] → 고객사코드(CID)에 **TC0ONETIME** 입력 > \[전체 저장] 클릭
-
+ ![]()
+
-
-### **실** 환경 구성방법
+
+ ### **실** 환경 구성방법
-**테스트모드 OFF** 처리 이후 카드사 심사 완료 후 카카오페이에서 발급받은 실상점 정보를 설정합니다.
+ **테스트모드 OFF** 처리 이후 카드사 심사 완료 후 카카오페이에서 발급받은 실상점 정보를 설정합니다.
-![]()
-
-
+ ![]()
+
## 정기결제
@@ -33,17 +31,15 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
### 카카오페이의 정기결제는 결제창 방식만 지원합니다.
-
-### 테스트 환경 구성방법
-
-[아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]카카오페이 선택 → 테스트모드 \[ON] → 고객사코드(CID)에 '**TCSUBSCRIP**' 입력 > \[전체 저장] 클릭
+
+ ### 테스트 환경 구성방법
-![]()
+ [아임포트 관리자 콘솔](https://admin.iamport.kr/)→ 시스템설정 → PG설정(**일반결제 및 정기결제**) → PG사 \[간편결제]카카오페이 선택 → 테스트모드 \[ON] → 고객사코드(CID)에 '**TCSUBSCRIP**' 입력 > \[전체 저장] 클릭
-### 실 환경 구성방법
+ ![]()
-**테스트모드 OFF** 처리 이후 카드사 심사 완료 후 카카오페이에서 발급받은 실상점 정보를 설정합니다.
+ ### 실 환경 구성방법
-
+ **테스트모드 OFF** 처리 이후 카드사 심사 완료 후 카카오페이에서 발급받은 실상점 정보를 설정합니다.
+
-
diff --git a/src/content/docs/en/ready/2-pg/readme.mdx b/src/content/docs/en/ready/2-pg/readme.mdx
index 8ee2848fe..66f91702f 100644
--- a/src/content/docs/en/ready/2-pg/readme.mdx
+++ b/src/content/docs/en/ready/2-pg/readme.mdx
@@ -7,7 +7,7 @@ description: >-
import Figure from "~/components/Figure.astro";
-After creating an i'mport account, go to the Admin page and click **Payment integration** **->**
+After creating an i'mport account, go to the Admin page and click **Payment integration ->**
**Test settings** tab and select the target PG.
You can configure PG-specific test settings from the **Test settings** tab.
diff --git a/src/content/docs/en/ready/3.mdx b/src/content/docs/en/ready/3.mdx
index 0c0846de4..8219b24a7 100644
--- a/src/content/docs/en/ready/3.mdx
+++ b/src/content/docs/en/ready/3.mdx
@@ -4,9 +4,9 @@ description: Learn how to check information needed to integrate your payment win
---
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
Check information required for payment window integration and API call as follows:
@@ -16,8 +16,7 @@ Check information required for payment window integration and API call as follow
2. Check your **Merchant ID/REST API Key/ REST API Secret**
-Since this is **sensitive information** that can be used to **manipulate payment details**, take caution to protect it from unauthorized access.
-
+ Since this is **sensitive information** that can be used to **manipulate payment details**, take caution to protect it from unauthorized access.
@@ -25,23 +24,20 @@ Since this is **sensitive information** that can be used to **manipulate payment
-
-- A **unique value assigned to each ChaiPort admin console account**.
-- A unique code used to **initialize the object** when calling the payment window.
-- Provide this ID when making a **technical inquiry** for a faster response.
-
-
-
-
-- A value required to request an **access token** for an API call.
-- Take **special care to protect it from unauthorized access**.
-
-
-
-
-- A value required to request an **access token** for an API call.
-- The value can be reissued, and periodic reissuance is recommended for enhanced security.
-- Take **special care to protect it from unauthorized access**.
-
-
+
+ - A **unique value assigned to each ChaiPort admin console account**.
+ - A unique code used to **initialize the object** when calling the payment window.
+ - Provide this ID when making a **technical inquiry** for a faster response.
+
+
+
+ - A value required to request an **access token** for an API call.
+ - Take **special care to protect it from unauthorized access**.
+
+
+
+ - A value required to request an **access token** for an API call.
+ - The value can be reissued, and periodic reissuance is recommended for enhanced security.
+ - Take **special care to protect it from unauthorized access**.
+
diff --git a/src/content/docs/en/ready/readme.mdx b/src/content/docs/en/ready/readme.mdx
index 125ecc0a3..f8bab3a5d 100644
--- a/src/content/docs/en/ready/readme.mdx
+++ b/src/content/docs/en/ready/readme.mdx
@@ -5,28 +5,26 @@ description: >-
i'mport.
---
-import Details from "~/components/gitbook/Details.astro";
import Figure from "~/components/Figure.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Details from "~/components/gitbook/Details.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## 1. Create an i'mport account
-For payment integration, you must first create an account from the i'mport Admin [**Sign Up**](https://admin.iamport.kr) page.
-
-You can sign up for **free without a contract**.
+ For payment integration, you must first create an account from the i'mport Admin [**Sign Up**](https://admin.iamport.kr) page.
+ You can sign up for **free without a contract**.
-
Create an i'mport account now
-
-Just need to provide your "**email address"**.
+
Create an i'mport account now
-Use a “**strong password**" to protect it from unauthorized access.
+ Just need to provide your "**email address"**.
+ Use a “**strong password**" to protect it from unauthorized access.
Click **Sign up** from the pages below to create an account.
@@ -35,7 +33,7 @@ Click **Sign up** from the pages below to create an account.
## 2. Set up PG
-After creating an i'mport account, go to the Admin page and click **Payment integration** **->**
+After creating an i'mport account, go to the Admin page and click **Payment integration ->**
**Test settings** tab and select the target PG.
You can configure PG-specific test settings from the **Test settings** tab.
@@ -43,8 +41,7 @@ You can configure PG-specific test settings from the **Test settings** tab.
-**Test settings and live account settings** for each PG are **different.** For detailed information about each PG settings, go to [**Set up PG**](2.-pg/).
-
+ **Test settings and live account settings** for each PG are **different.** For detailed information about each PG settings, go to [**Set up PG**](2.-pg/).
## 3. Check integration settings
@@ -52,13 +49,12 @@ You can configure PG-specific test settings from the **Test settings** tab.
You can check the integration settings required for payment window integration and API calls.
1. Log in to [**i'mport Admin Console**](https://admin.iamport.kr) -> **Merchant account**
- -> Select **My ID - API Keys**
+ -> Select **My ID - API Keys**
2. Check your **Merchant ID/REST API Key/REST API Secret**.
-Since this is **sensitive data** that can be used to **manipulate payment details**, be sure to protect it from unauthorized access.
-
+ Since this is **sensitive data** that can be used to **manipulate payment details**, be sure to protect it from unauthorized access.
@@ -66,23 +62,20 @@ Since this is **sensitive data** that can be used to **manipulate payment detail
-
-- A **unique value assigned to each ChaiPort Admin console account**.
-- A unique code used to **initialize the object** when calling the payment window.
-- Provide this ID when making a **technical inquiry** for a faster response.
-
-
-
-
-- A value required to request an **access token** for an API call.
-- Take **special care to protect it from unauthorized access**.
-
-
-
-
-- A value required to request an **access token** for an API call.
-- The value can be reissued, and periodic reissuance is recommended for enhanced security.
-- Take **special care to protect it from unauthorized access**.
-
-
+
+ - A **unique value assigned to each ChaiPort Admin console account**.
+ - A unique code used to **initialize the object** when calling the payment window.
+ - Provide this ID when making a **technical inquiry** for a faster response.
+
+
+
+ - A value required to request an **access token** for an API call.
+ - Take **special care to protect it from unauthorized access**.
+
+
+
+ - A value required to request an **access token** for an API call.
+ - The value can be reissued, and periodic reissuance is recommended for enhanced security.
+ - Take **special care to protect it from unauthorized access**.
+
diff --git a/src/content/docs/en/result/webhook.mdx b/src/content/docs/en/result/webhook.mdx
index 0843aa4bc..4988c82d7 100644
--- a/src/content/docs/en/result/webhook.mdx
+++ b/src/content/docs/en/result/webhook.mdx
@@ -3,32 +3,31 @@ title: Set up a webhook
description: Set up a webhook to handle the payment result in a reliable way.
---
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
-#### Use the i'mport webhook to synchronize payment information on the i'mport server with the merchant server to compensate for data loss due to device or network instability.
+**Use the i'mport webhook to synchronize payment information on the i'mport server
+with the merchant server to compensate for data loss due to device or network instability.**
-![]()
+
-**What is a webhook?**
-
-A webhook is a mechanism for sending notifications to other services or applications when a specific event occurs.
-The webhook provider sends event information to the callback URL (endpoint) by creating an `HTTP POST` request
-when the event occurs. Webhooks are much more efficient in terms of resources and communication
-as they can only receive information related to desired events without polling data periodically.
-Using webhooks, you can extend functionality by integrating with custom functions or other applications.
+ **What is a webhook?**
+ A webhook is a mechanism for sending notifications to other services or applications when a specific event occurs.
+ The webhook provider sends event information to the callback URL (endpoint) by creating an `HTTP POST` request
+ when the event occurs. Webhooks are much more efficient in terms of resources and communication
+ as they can only receive information related to desired events without polling data periodically.
+ Using webhooks, you can extend functionality by integrating with custom functions or other applications.
-**Is webhook integration required?**
-
-When the i'mport server sends a response to the client, the client may not receive the response
-after the payment process is complete for reasons, such as Wi-Fi disconnection or automatic browser reload.
-In this case, the i'mport server sends a webhook event to the server so that the payment information can be synchronized.
+ **Is webhook integration required?**
+ When the i'mport server sends a response to the client, the client may not receive the response
+ after the payment process is complete for reasons, such as Wi-Fi disconnection or automatic browser reload.
+ In this case, the i'mport server sends a webhook event to the server so that the payment information can be synchronized.
i'mport webhook is called when:
@@ -40,60 +39,60 @@ i'mport webhook is called when:
> - **Refund is processed from Admin console** (status : `cancelled`)
-**A webhook is not invoked when payment fails!**
-
+ **A webhook is not invoked when payment fails!**
Webhook URL can be set in the following two ways:
-
-![]()
-
-To set the webhook's notification URL to send the payment information to, log in to the **Admin console** and then go to [**Payments->Live Settings**](https://admin.iamport.kr/integration?tab=production) tab and set the URL in the **Endpoint URL** field to receive the webhook data.
-
-**Content-Type** can be specified as `application/json` or `application/x-www-form-urlencoded`. To test the URL, click the **Test Webhook** button to the right of the Notification URL field.
-
-
-
-
-Set the **notice\_url** parameter when calling the JavaScript SDK **request\_pay** function to receive a webhook notification. Use this method to specify a different webhook URL for each payment request.
-
-(If this parameter is specified, the Admin console's **webhook setting is ignored**.)
-
-```javascript title="client-side"
-function requestPay() {
- // IMP.request_pay(param, callback) call payment window
- IMP.request_pay({
- ... // Omitted
- notice_url : 'https://Webhook URL', // Set Webhook URL
- ... // Omitted
- }, function (rsp) { // callback
- if (rsp.success) {
+
+ ![]()
+
+ To set the webhook's notification URL to send the payment information to, log in to the **Admin console** and then go to [**Payments->Live Settings**](https://admin.iamport.kr/integration?tab=production) tab and set the URL in the **Endpoint URL** field to receive the webhook data.
+
+ **Content-Type** can be specified as `application/json` or `application/x-www-form-urlencoded`. To test the URL, click the **Test Webhook** button to the right of the Notification URL field.
+
+
+
+ Set the **notice\_url** parameter when calling the JavaScript SDK **request\_pay** function to receive a webhook notification. Use this method to specify a different webhook URL for each payment request.
+
+ (If this parameter is specified, the Admin console's **webhook setting is ignored**.)
+
+ ```ts title="client-side"
+ function requestPay() {
+ // IMP.request_pay(param, callback) call payment window
+ IMP.request_pay(
+ {
+ // ...Omitted
+ notice_url: "https://Webhook URL", // Set Webhook URL
+ // ...Omitted
+ },
+ function (rsp) {
+ // callback
+ if (rsp.success) {
console.log(rsp);
- } else {
+ } else {
console.log(rsp);
- }
- });
-}
-```
-
-
+ }
+ },
+ );
+ }
+ ```
+
-**About webhooks**
-
-**You cannot set multiple webhook URLs.**
+ **About webhooks**
-Webhooks can be sent via initial or resend, each with different timeouts.
+ **You cannot set multiple webhook URLs.**
-1. For the initial webhook, the **Connection TimeOut is set to 10 seconds** and the **Read TimeOut waiting for the response is 30 seconds**.
-2. For the Resend Webhook, the **Overall TimeOut for the request is 15 seconds**.
+ Webhooks can be sent via initial or resend, each with different timeouts.
+ 1. For the initial webhook, the **Connection TimeOut is set to 10 seconds** and the **Read TimeOut waiting for the response is 30 seconds**.
+ 2. For the Resend Webhook, the **Overall TimeOut for the request is 15 seconds**.
-### Verify webhook request
+## Verify webhook request
When a Webhook event is triggered, a `POST` request is generated to the configured URL endpoint as
follows.
@@ -115,12 +114,11 @@ have set up the webhook retry feature. It is recommended to handle potential mul
the same webhook content without issues.
-
-```url
-curl -H "Content-Type: application/json" -X POST -d '{ "imp_uid": "imp_1234567890", "merchant_uid": "order_id_8237352", "status": "paid" }' { NotificationURL }
-```
-
-
+
+ ```url
+ curl -H "Content-Type: application/json" -X POST -d '{ "imp_uid": "imp_1234567890", "merchant_uid": "order_id_8237352", "status": "paid" }' { NotificationURL }
+ ```
+
> The body of the webhook `POST` request contains the following information. The server can get the
@@ -134,65 +132,73 @@ curl -H "Content-Type: application/json" -X POST -d '{ "imp_uid": "imp_123456789
Sample code of receiving a POST request to webhook endpoint URL
-
-Create an endpoint to receive the webhook event's `POST` request as follows and then parse, verify, and save the payment information.
-
-```javascript title="server-side"
-app.use(bodyParser.json());
- ...
- // Route POST request to "/iamport-webhook"
- app.post("/iamport-webhook", async (req, res) => {
- try {
+
+ Create an endpoint to receive the webhook event's `POST` request as follows and then parse, verify, and save the payment information.
+
+ ```ts title="server-side"
+ app.use(bodyParser.json());
+ // Route POST request to "/iamport-webhook"
+ app.post("/iamport-webhook", async (req, res) => {
+ try {
const { imp_uid, merchant_uid } = req.body; // Get imp_uid and merchant_uid from req.body
// Get access token
/* ...Omitted... */
// Get payment info from i'mport server using imp_uid
/* ...Omitted... */
const paymentData = getPaymentData.data.response; // Save payment info
- ...
+ // ...
// Query for original requested amount from the database
const order = await Orders.findById(paymentData.merchant_uid);
const amountToBePaid = order.amount; // Original requested amount
- ...
+ // ...
// Verify payment amount
const { amount, status } = paymentData;
- if (amount === amountToBePaid) { // Amounts match. Processed amount === Original requested amount
+ if (amount === amountToBePaid) {
+ // Amounts match. Processed amount === Original requested amount
await Orders.findByIdAndUpdate(merchant_uid, { $set: paymentData }); // Save payment info in DB
switch (status) {
case "ready": // Issue virtual account
// Save virtual account info in DB
const { vbank_num, vbank_date, vbank_name } = paymentData;
- await Users.findByIdAndUpdate("/* customer id */", { $set: { vbank_num, vbank_date, vbank_name }});
+ await Users.findByIdAndUpdate("/* customer id */", {
+ $set: { vbank_num, vbank_date, vbank_name },
+ });
// Send virtual account issuance text message
- SMS.send({ text: \`Virtual account has been issued. Account information \${vbank_num} \${vbank_date} \${vbank_name}\`});
- res.send({ status: "vbankIssued", message: "Virtual account issued successfully" });
+ SMS.send({
+ text: `Virtual account has been issued. Account information ${vbank_num} ${vbank_date} ${vbank_name}`,
+ });
+ res.send({
+ status: "vbankIssued",
+ message: "Virtual account issued successfully",
+ });
break;
case "paid": // Payment complete
res.send({ status: "success", message: "Payment successful." });
break;
}
- } else { // Amount mismatch. Forged/falsified payment.
- throw { status: "forgery", message: "Forged/falsified payment attempted" };
+ } else {
+ // Amount mismatch. Forged/falsified payment.
+ throw {
+ status: "forgery",
+ message: "Forged/falsified payment attempted",
+ };
}
- } catch (e) {
- res.status(400).send(e);
- }
- });
-```
-
-
+ } catch (e) {
+ res.status(400).send(e);
+ }
+ });
+ ```
+
-**i'mport does not guarantee the order of payment information delivery**
-
-In general, after i'mport server calls webhook, it does not guarantee the order in which the payment information arrives at the server. This is because i'mport sends a 302 redirect response to the client without waiting for a webhook response from the server. However, you can submit a special request to configure i'mport to wait for a webhook response before sending a 302 redirect or callback response to the client so that the server always receives payment information from i'mport first. To make a request to guarantee the prioritized delivery of webhooks, contact [support@iamport.kr](mailto:support@iamport.kr) with the merchant ID.
+ **i'mport does not guarantee the order of payment information delivery**
+ In general, after i'mport server calls webhook, it does not guarantee the order in which the payment information arrives at the server. This is because i'mport sends a 302 redirect response to the client without waiting for a webhook response from the server. However, you can submit a special request to configure i'mport to wait for a webhook response before sending a 302 redirect or callback response to the client so that the server always receives payment information from i'mport first. To make a request to guarantee the prioritized delivery of webhooks, contact [support@iamport.kr](mailto:support@iamport.kr) with the merchant ID.
-**Can you re-send a webhook?**
-
-By default, a webhook can only be sent once. However, it can be re-sent up to 5 times as per merchant's request. Webhooks are re-sent every 1 minute until a successful response is received from the merchant (**up to 5 times**).
+ **Can you re-send a webhook?**
+ By default, a webhook can only be sent once. However, it can be re-sent up to 5 times as per merchant's request. Webhooks are re-sent every 1 minute until a successful response is received from the merchant (**up to 5 times**).
diff --git a/src/content/docs/en/sdk/javascript-sdk/identity-verification-request-parameters.mdx b/src/content/docs/en/sdk/javascript-sdk/identity-verification-request-parameters.mdx
index e62b6b4dd..6c09e5d7e 100644
--- a/src/content/docs/en/sdk/javascript-sdk/identity-verification-request-parameters.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/identity-verification-request-parameters.mdx
@@ -3,7 +3,7 @@ title: Identity verification request parameters
description: ''
---
-### certification(param, callback)
+## certification(param, callback)
> **`merchant_uid`** **\*** **string**
>
@@ -13,7 +13,7 @@ description: ''
> **`min_age`** ******integer**
>
-> **Minimum age allowed** **for verification**
+> **Minimum age allowed for verification**
>
> Only supported by Danal PG verification
diff --git a/src/content/docs/en/sdk/javascript-sdk/identity-verification-response-parameters.mdx b/src/content/docs/en/sdk/javascript-sdk/identity-verification-response-parameters.mdx
index c64ec29ea..28557edef 100644
--- a/src/content/docs/en/sdk/javascript-sdk/identity-verification-response-parameters.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/identity-verification-response-parameters.mdx
@@ -3,7 +3,7 @@ title: Identity verification response parameters
description: ''
---
-### rsp (Object)
+## rsp (Object)
> **`success`** **\*** **boolean**
>
diff --git a/src/content/docs/en/sdk/javascript-sdk/readme.mdx b/src/content/docs/en/sdk/javascript-sdk/readme.mdx
index 5e11d96d5..b2c982f41 100644
--- a/src/content/docs/en/sdk/javascript-sdk/readme.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/readme.mdx
@@ -7,11 +7,11 @@ import Hint from "~/components/Hint.astro";
You can use the **i'mport JavaScript SDK** to open the payment or identity verification window from
your website or app. For **version history** and notable changes in each version, refer to the
-[**Release Notes**](sdk-release-note).\
+[**Release Notes**](sdk-release-note).
-### Loading SDK Library
+## Loading SDK Library
-To use the **i'mport JavaScript SDK**, you must first load the library on the page as shown below. It is recommended to load it from the CDN (**https://cdn.iamport.kr/js/iamport.payment-{SDK-latest-version}.js**). When the library is loaded, you can call **IMP** functions by accessing the **IMP** global object as a property of the **window** object.
+To use the **i'mport JavaScript SDK**, you must first load the library on the page as shown below. It is recommended to load it from the CDN (**[https://cdn.iamport.kr/js/iamport.payment-\{SDK-latest-version}.js](https://cdn.iamport.kr/js/iamport.payment-\{SDK-latest-version}.js)**). When the library is loaded, you can call **IMP** functions by accessing the **IMP** global object as a property of the **window** object.
```html title="HTML"
@@ -27,8 +27,7 @@ To use the **i'mport JavaScript SDK**, you must first load the library on the pa
```
-You **must install jQuery 1.0 or later version**.
-
+ You **must install jQuery 1.0 or later version**.
-> #### **If you cannot use CDN**, use the following: [https://service.iamport.kr/js/iamport.payment-](https://service.iamport.kr/js/iamport.payment-1.2.0.js)\{SDK-latest-version}[.js](https://service.iamport.kr/js/iamport.payment-1.2.0.js)
+> **If you cannot use CDN**, use the following: [https://service.iamport.kr/js/iamport.payment-](https://service.iamport.kr/js/iamport.payment-1.2.0.js)\{SDK-latest-version}[.js](https://service.iamport.kr/js/iamport.payment-1.2.0.js)
diff --git a/src/content/docs/en/sdk/javascript-sdk/rps.mdx b/src/content/docs/en/sdk/javascript-sdk/rps.mdx
index 4b38f190f..3aece5d8c 100644
--- a/src/content/docs/en/sdk/javascript-sdk/rps.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/rps.mdx
@@ -5,13 +5,13 @@ description: ""
import Codepen from "~/components/gitbook/Codepen.astro";
import Details from "~/components/gitbook/Details.astro";
-import Hint from "~/components/Hint.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
+import Hint from "~/components/Hint.astro";
## Parameters
-> **`pg`** **\***\*\* ****string\*\*
+> **`pg`** **\*** **string**
>
> **PG code**
>
@@ -19,7 +19,7 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
>
> [**PG codes**](../../tips/pg-codes)
-> **`pay_method`** **\***\*\* ****string\*\*
+> **`pay_method`** **\*** **string**
>
> **Payment method code**
>
@@ -28,29 +28,28 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
> [**Payment integration by PG**](../../payment-integration-by-pg/payment-gateways/readme)
-
+ 1. KRW
+ 2. USD
+ 3. EUR
+ 4. JPY
> **`language`** **string**
@@ -117,11 +115,10 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
> **Language for payment window** (Supported by only some PGs.)
-
Language codes
-
-- en (English)
-- ko (Korean)
+
Language codes
+ - en (English)
+ - ko (Korean)
> **`buyer_name`** **\*** **string**
@@ -150,9 +147,9 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
> **`confirm_url`** **string**
>
-> **Merchant endpoint url when using** [**confirm_process**](../../tips/confirm-process)
+> **Merchant endpoint url when using** [**confirm\_process**](../../tips/confirm-process)
>
-> - Must request for use to support@iamport.kr.
+> - Must request for use to [support@iamport.kr](mailto:support@iamport.kr).
> **`notice_url`** **string**
>
@@ -208,78 +205,78 @@ import Tab from "~/components/gitbook/tabs/Tab.astro";
## Additional functions
-
-```javascript title="javascript"
-display: {
- card_quota: [6] // Display up to 6 months installment plans
-}
-```
-
-**Parameters**
-
-- **card_quota :**
- - `[]`: Only immediate pay
- - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans\
+
+ ```json title="javascript"
+ {
+ "display": {
+ "card_quota": [6] // Display up to 6 months installment plans
+ }
+ }
+ ```
-
-Installment plan option is available only for **KRW 50,000 or more**.
+ **Parameters**
-
+ - **card\_quota :**
+ - `[]`: Only immediate pay
+ - `2,3,4,5,6`: immediate, 2, 3, 4, 5, 6 month installment plans
-Example of allowing up to **3 months**** installment plans**
+
+ Installment plan option is available only for **KRW 50,000 or more**.
+
-
+ Example of allowing up to **3 months** installment plans
-
+
+
-
-```javascript title="javascript"
-card: {
- direct: {
- code: "367",
- quota: 3
+
+ ```json title="javascript"
+ {
+ "card": {
+ "direct": {
+ "code": "367",
+ "quota": 3
+ }
+ }
}
-}
-```
-
-**Parameters**
+ ```
-- **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
-- **quota**: Installment plan. For immediate, set to 0. (**integer**)
+ **Parameters**
-
-**Precautions**
+ - **code**: [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string**)
+ - **quota**: Installment plan. For immediate, set to 0. (**integer**)
-- Currently, direct call to the credit card company's payment window is only supported by 6 PGs: **KG Inicis, KCP, Toss Payments, Nice Payments, KICC, and Danal**.
-- Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
+
+ **Precautions**
-
+ - Currently, direct call to the credit card company's payment window is only supported by 6 PGs: **KG Inicis, KCP, Toss Payments, Nice Payments, KICC, and Danal**.
+ - Some PGs do not support direct call to credit card company's payment windows for all Merchant IDs. You must check your Merchant ID with each PG for direct call support.
+
-\
-Example of direct call to **Hyundai Card** module
+ Example of direct call to **Hyundai Card** module
-
+
+
-
-
-
-```javascript title="javascript"
-card : {
- detail : [
- {card_code:"*", enabled:false}, // Disable all credit cards
- {card_code:'366', enabled:true} // Enable specific credit card
- ]
-}
-```
-
-**Parameters**
+
+ ```json title="javascript"
+ {
+ "card": {
+ "detail": [
+ { "card_code": "*", "enabled": false }, // Disable all credit cards
+ { "card_code": "366", "enabled": true } // Enable specific credit card
+ ]
+ }
+ }
+ ```
-- **card_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
-- **enabled:** Option to enable the credit card (**boolean)**
+ **Parameters**
-**Example of enabling only ****Shinhan Card**** payment window**
+ - **card\_code:** [**Credit card code**](https://chaifinance.notion.site/53589280bbc94fab938d93257d452216?v=eb405baf52134b3f90d438e3bf763630) (**string)**
+ - **enabled:** Option to enable the credit card (**boolean)**
-
+ **Example of enabling only ****Shinhan Card**** payment window**
-
+
+
diff --git a/src/content/docs/en/sdk/javascript-sdk/sdk-release-note.mdx b/src/content/docs/en/sdk/javascript-sdk/sdk-release-note.mdx
index f37723511..a994b18e1 100644
--- a/src/content/docs/en/sdk/javascript-sdk/sdk-release-note.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/sdk-release-note.mdx
@@ -7,240 +7,243 @@ description: >-
import Details from "~/components/gitbook/Details.astro";
-### Version 1.2.0
+## Version 1.2.0
-
TBU
-
+
TBU
-### Version 1.1.8
+## Version 1.1.8
-
Details
+
Details
-**Changed Kakao Pay mobile payment to use redirection mode**
+ **Changed Kakao Pay mobile payment to use redirection mode**
-In compliance with the iframe non-support policy of Kakao Pay SDK, Kakao Pay mobile payment is processed now via page redirection instead of iframe.In the previous version, when the Kakao Pay mobile payment process is completed after calling `IMP.request_pay`, the specified callback is invoked as in PC web. In mobile, Kakao Pay is now processed via redirection mode.\
+ In compliance with the iframe non-support policy of Kakao Pay SDK, Kakao Pay mobile payment is processed now via page redirection instead of iframe.In the previous version, when the Kakao Pay mobile payment process is completed after calling `IMP.request_pay`, the specified callback is invoked as in PC web. In mobile, Kakao Pay is now processed via redirection mode.\\
-**Added Naver Pay (Checkout) pop-up mode (redirection as default mode)**
+ **Added Naver Pay (Checkout) pop-up mode (redirection as default mode)**
-To open the Naver Pay (Checkout) window as pop-up, set `popup: true` when calling `IMP.request_pay`. The callback mode is used by default.To avoid issues, such as browser pop-up blocking, Naver Pay recommends page redirection in both PC and mobile.
+ To open the Naver Pay (Checkout) window as pop-up, set `popup: true` when calling `IMP.request_pay`. The callback mode is used by default.To avoid issues, such as browser pop-up blocking, Naver Pay recommends page redirection in both PC and mobile.
-- **1.1.8 and later versions**
- - PC/mobile: redirection is default, set to `popup : true` to enable popup mode.
-- **1.1.7 and earlier versions (`popup` not supported)**
- - PC: pop-up (new tab) mode
- - Mobile: redirection mode
+ - **1.1.8 and later versions**
+ - PC/mobile: redirection is default, set to `popup : true` to enable popup mode.
-**Added redirection mode for Eximbay**
+ - **1.1.7 and earlier versions (`popup` not supported)**
+ - PC: pop-up (new tab) mode
+ - Mobile: redirection mode
-To redirect to a page after payment process is completed, set `popup : false` when calling `IMP.request_pay`. To avoid pop-up blocking issues in mobile app WebView, use the redirection mode.
+ **Added redirection mode for Eximbay**
-- **1.1.8 and later versions**
- - PC/mobile: popup is default, set to `popup : false` to enable redirection mode.
-- **1.1.7 and earlier versions (`popup` not supported)**
- - PC/mobile: popup mode
+ To redirect to a page after payment process is completed, set `popup : false` when calling `IMP.request_pay`. To avoid pop-up blocking issues in mobile app WebView, use the redirection mode.
-**Multiple PG support for identity verification**
+ - **1.1.8 and later versions**
+ - PC/mobile: popup is default, set to `popup : false` to enable redirection mode.
-Added support for multiple PG modules in identity verification due to the addition of the `INICIS-Credit card identity verification` method to the existing `Danal-Mobile identity verification` method. You can also get multiple CPIDs, one for each website, for 'Danal-Mobile identity verification', and specify a module via `pg: danal.{Danal CPID}`.
+ - **1.1.7 and earlier versions (`popup` not supported)**
+ - PC/mobile: popup mode
-```javascript title="Danal-mobile identity verification"
- IMP.certification({
- pg: "danal", // danal or danal.{Danal CPID}, other parameters omitted
- ...
- ...
- }, function(rsp) {
- if ( rsp.success ) {
- // Verification successful, return imp_uid, merchant_uid (rsp.imp_uid, rsp.merchant_uid)
- } else {
- // Verification failed, terminate
- }
- });
-```
+ **Multiple PG support for identity verification**
+
+ Added support for multiple PG modules in identity verification due to the addition of the `INICIS-Credit card identity verification` method to the existing `Danal-Mobile identity verification` method. You can also get multiple CPIDs, one for each website, for 'Danal-Mobile identity verification', and specify a module via `pg: danal.{Danal CPID}`.
+
+ ```ts title="Danal-mobile identity verification"
+ IMP.certification(
+ {
+ pg: "danal", // danal or danal.{Danal CPID}, other parameters omitted
+ // ...
+ },
+ function (rsp) {
+ if (rsp.success) {
+ // Verification successful, return imp_uid, merchant_uid (rsp.imp_uid, rsp.merchant_uid)
+ } else {
+ // Verification failed, terminate
+ }
+ },
+ );
+ ```
-```javascript title="Inicis-credit card identity verification"
-// popup : true by default in both PC/mobile
-// PC : applies popup mode regardless of popup parameter setting (INICIS policy)
-// Mobile : for redirection mode, set popup : false and m_redirect_url is required
-IMP.certification({
+ ```ts title="Inicis-credit card identity verification"
+ // popup : true by default in both PC/mobile
+ // PC : applies popup mode regardless of popup parameter setting (INICIS policy)
+ // Mobile : for redirection mode, set popup : false and m_redirect_url is required
+ IMP.certification({
pg: "inicis", //inicis or inicis.{Inicis MID}, other parameters omitted
m_redirect_url: "https://shop.yourservice.com/user-certificates/complete",
- ...
- ...
-});
-```
-
-#### Bug Fixes
+ // ...
+ });
+ ```
-**The issue of white screen being displayed when the browser's Back button is pressed while processing payment in redirection mode in Safari on iPhone**
+ ### Bug Fixes
-This is caused by the page being rendered by restoring the DOM element in the state before the page redirection when you return to the previous page with the Back button of the Safari browser (applicable to all PGs that use the redirection mode). The white screen issue is now resolved.
+ **The issue of white screen being displayed when the browser's Back button is pressed while processing payment in redirection mode in Safari on iPhone**
+ This is caused by the page being rendered by restoring the DOM element in the state before the page redirection when you return to the previous page with the Back button of the Safari browser (applicable to all PGs that use the redirection mode). The white screen issue is now resolved.
-### Version 1.1.7
+## Version 1.1.7
-
Details
+
Details
-**Added popup mode for PayPal**
+ **Added popup mode for PayPal**
-To open the payment window as pop-up, set `popup: true` when calling `IMP.request_pay(param, callback)`. The `callback` function is called after the payment process is completed. Previous versions only support the page redirection mode.
+ To open the payment window as pop-up, set `popup: true` when calling `IMP.request_pay(param, callback)`. The `callback` function is called after the payment process is completed. Previous versions only support the page redirection mode.
-```javascript title="javascript popup mode"
+ ```ts title="javascript popup mode"
// Set popup : true and callback, other parameters omitted
- IMP.request_pay({
- pg: "paypal",
- popup: true,
- ...
- ...
- }, function(rsp) {
- if ( rsp.success ) {
- //Paypal payment successful, execute validation logic
- } else {
- //Paypal payment terminated or failed
- }
- });
-```
-
-```javascript title="javascript redirect mode"
- // Set m_redirect_url (popup : false by default, not set explicitly)
+ IMP.request_pay(
+ {
+ pg: "paypal",
+ popup: true,
+ // ...
+ },
+ function (rsp) {
+ if (rsp.success) {
+ //Paypal payment successful, execute validation logic
+ } else {
+ //Paypal payment terminated or failed
+ }
+ },
+ );
+ ```
+
+ ```ts title="javascript redirect mode"
+ // Set m_redirect_url (popup : false by default, not set explicitly)
IMP.request_pay({
pg: "paypal",
m_redirect_url: "https://shop.yourservice.com/payments/complete",
- ...
- ...
+ // ...
});
-```
+ ```
-**Added redirection mode for Danal identity verification**
+ **Added redirection mode for Danal identity verification**
-To redirect to a page after identity verification, set the target page's URL in `m_redirect_url` when calling `IMP.certification`. Previous versions only support the callback mode. For more information about using the redirection mode, refer to the [Mobile identity verification](../../etc/phone/) page.
+ To redirect to a page after identity verification, set the target page's URL in `m_redirect_url` when calling `IMP.certification`. Previous versions only support the callback mode. For more information about using the redirection mode, refer to the [Mobile identity verification](../../etc/phone/) page.
-```javascript title="javascript (popup mode)"
+ ```ts title="javascript (popup mode)"
// Set popup : true
- IMP.certification({
- merchant_uid : "verification transaction ID",
- popup: true
- }, function(rsp) {
- if ( rsp.success ) {
- // Verification successful
- } else {
- // Verification failed or terminated (popup closed or Cancel button clicked)
- }
- });
-```
-
-```javascript title="javascript redirect mode"
+ IMP.certification(
+ {
+ merchant_uid: "verification transaction ID",
+ popup: true,
+ },
+ function (rsp) {
+ if (rsp.success) {
+ // Verification successful
+ } else {
+ // Verification failed or terminated (popup closed or Cancel button clicked)
+ }
+ },
+ );
+ ```
+
+ ```ts title="javascript redirect mode"
// Set m_redirect_url (popup : false by default, not set explicitly)
IMP.certification({
- merchant_uid : "verification transaction ID"
+ merchant_uid: "verification transaction ID",
m_redirect_url: "https://shop.yourservice.com/payments/complete",
});
-```
+ ```
-#### Bug Fixes
+ ### Bug Fixes
-**The issue of callback not being invoked when you click the close button (X button) in the identity verification (Danal) pop-up**
+ **The issue of callback not being invoked when you click the close button (X button) in the identity verification (Danal) pop-up**
-When you close the identity verification pop-up window or click the Cancel button on the page in the pop-up mode, the callback (handler) of `IMP.certification(param, handler)` is invoked. This fix implements the same behavior for when the X button is clicked.
-
-
+ When you close the identity verification pop-up window or click the Cancel button on the page in the pop-up mode, the callback (handler) of `IMP.certification(param, handler)` is invoked. This fix implements the same behavior for when the X button is clicked.
+
-### Version 1.1.5 and earlier versions
+## Version 1.1.5 and earlier versions
-
Details
-
-#### iamport.payment-1.1.5.js
+
Details
-```html
-
-```
+ ### iamport.payment-1.1.5.js
-**Deployed on 2017-04-03**
+ ```html
+
+ ```
-- Added function to redirect to `m_redirect_url` when error occurs before starting the payment process after calling `IMP.request_pay(param)` in mobile.
+ **Deployed on 2017-04-03**
-**Reasons for failure before starting payment process**
+ - Added function to redirect to `m_redirect_url` when error occurs before starting the payment process after calling `IMP.request_pay(param)` in mobile.
-- Reusing an already used `merchant_uid` (Order ID) for payment.
-- Invalid payment request parameter.
+ **Reasons for failure before starting payment process**
-**Reasons for failure after starting payment process**
+ - Reusing an already used `merchant_uid` (Order ID) for payment.
+ - Invalid payment request parameter.
-- Credit card suspended or limit exceeded.
-- Exceeded number of password errors.
+ **Reasons for failure after starting payment process**
-#### iamport.payment-1.1.4.js
+ - Credit card suspended or limit exceeded.
+ - Exceeded number of password errors.
-```html
-
-```
+ ### iamport.payment-1.1.4.js
-**Deployed on 2016-11-14**
+ ```html
+
+ ```
-- Added Agency-tier feature: `IMP.agency(Merchant ID, Tier Code)` function
-- Added SMS mobile identity verification feature: `IMP.certification()` function
+ **Deployed on 2016-11-14**
-#### iamport.payment-1.1.3.js
+ - Added Agency-tier feature: `IMP.agency(Merchant ID, Tier Code)` function
+ - Added SMS mobile identity verification feature: `IMP.certification()` function
-```html
-
-```
+ ### iamport.payment-1.1.3.js
-**Deployed on 2016-07-13**
+ ```html
+
+ ```
-- Code refactored and performance enhanced version of 1.1.2 version.
+ **Deployed on 2016-07-13**
-#### iamport.payment-1.1.2.js
+ - Code refactored and performance enhanced version of 1.1.2 version.
-```html
-
-```
+ ### iamport.payment-1.1.2.js
-**Deployed on 2016-03-09**
+ ```html
+
+ ```
-- Enhanced method of calling multiple PG settings.
+ **Deployed on 2016-03-09**
-#### iamport.payment-1.1.1.js
+ - Enhanced method of calling multiple PG settings.
-```html
-
-```
+ ### iamport.payment-1.1.1.js
-**Deployed on 2016-02-19**
+ ```html
+
+ ```
-- Extended PG parameter value to allow for PG + MID combination (`pg : '{PG}.{MID}'`).
+ **Deployed on 2016-02-19**
-#### iamport.payment-1.1.0.js
+ - Extended PG parameter value to allow for PG + MID combination (`pg : '{PG}.{MID}'`).
-```html
-
-```
+ ### iamport.payment-1.1.0.js
-**Deployed on 2016-01-19**
+ ```html
+
+ ```
-- Added `pg` parameter to allow an account to use multiple PG modules (`pg : '{PG}'`)
+ **Deployed on 2016-01-19**
-#### iamport.payment-1.0.0.js
+ - Added `pg` parameter to allow an account to use multiple PG modules (`pg : '{PG}'`)
-```html
-
-```
+ ### iamport.payment-1.0.0.js
-**Deployed on 2014-10-24**
+ ```html
+
+ ```
-- Initial stable release (Unversioned release, same as iamport.payment-1.0.0.js)
+ **Deployed on 2014-10-24**
-#### iamport.payment.js
+ - Initial stable release (Unversioned release, same as iamport.payment-1.0.0.js)
-```html
-
-```
+ ### iamport.payment.js
+ ```html
+
+ ```
diff --git a/src/content/docs/en/sdk/javascript-sdk/undefined-1.mdx b/src/content/docs/en/sdk/javascript-sdk/undefined-1.mdx
index 9c50589f5..54ee89ccc 100644
--- a/src/content/docs/en/sdk/javascript-sdk/undefined-1.mdx
+++ b/src/content/docs/en/sdk/javascript-sdk/undefined-1.mdx
@@ -9,8 +9,7 @@ import Hint from "~/components/Hint.astro";
## Callback response data for payment request
-Properties that are returned vary by PG or payment method.
-
+ Properties that are returned vary by PG or payment method.
> **`success`** **\*** **boolean**
@@ -19,9 +18,7 @@ Properties that are returned vary by PG or payment method.
>
> True when payment is approved or virtual account is issued
>
->
-> (returned as`imp_success` for some PG/payment method)
->
+> (returned as`imp_success` for some PG/payment method)
> **`error_code`** **\*** **string**
>
@@ -50,29 +47,28 @@ Properties that are returned vary by PG or payment method.
> **Payment method code**
-
+
+ - naverpay
+ - kakopay
+ - payco
+ - samsungpay
+ - ssgpay
+ - lpay
+ - kpay
> **`pg_tid`** **\*** **string**
@@ -150,13 +148,12 @@ Properties that are returned vary by PG or payment method.
> **`paid_at`** **\*** **string**
>
-> **Payment approved at** **(UNIX timestamp)**
+> **Payment approved at (UNIX timestamp)**
-**What is UNIX timestamp?**
-
-**Unix time** is a way of representing time. It is also called POSIX time or **Epoch time**. The time elapsed from 00:00:00 Coordinated Universal Time (UTC) on January 1, 1970 is converted into seconds and expressed as an integer. In Unix time, leap seconds are ignored. It is used by Unix-like operating systems and several other operating systems and file formats. Because of the leap second processing method, time cannot be expressed linearly, and leap seconds cannot be expressed in Coordinated Universal Time.
+ **What is UNIX timestamp?**
+ **Unix time** is a way of representing time. It is also called POSIX time or **Epoch time**. The time elapsed from 00:00:00 Coordinated Universal Time (UTC) on January 1, 1970 is converted into seconds and expressed as an integer. In Unix time, leap seconds are ignored. It is used by Unix-like operating systems and several other operating systems and file formats. Because of the leap second processing method, time cannot be expressed linearly, and leap seconds cannot be expressed in Coordinated Universal Time.
> **`receipt_url`** **string**
@@ -176,8 +173,7 @@ Properties that are returned vary by PG or payment method.
> **Virtual account number**
-As received from PG, may contain special characters (-).
-
+ As received from PG, may contain special characters (-).
> **`vbank_name`** **string**
@@ -189,13 +185,12 @@ As received from PG, may contain special characters (-).
> **Virtual account holder**
-Shows business name on the contract. Some PGs may return null and requires additional processing.
-
+ Shows business name on the contract. Some PGs may return null and requires additional processing.
> **`vbank_date`** **string**
>
-> **Virtual account expiration** **(UNIX timestamp)**
+> **Virtual account expiration (UNIX timestamp)**
```json title="Sample response object"
{
diff --git a/src/content/docs/en/tips/agency-and-tier.mdx b/src/content/docs/en/tips/agency-and-tier.mdx
index c278e9aba..838c73ef1 100644
--- a/src/content/docs/en/tips/agency-and-tier.mdx
+++ b/src/content/docs/en/tips/agency-and-tier.mdx
@@ -6,7 +6,7 @@ description: Learn how to set up a main merchant and its sub-merchants.
import Figure from "~/components/Figure.astro";
import Hint from "~/components/Hint.astro";
-### You can use the i'mport Agent service to set up PGs for sub-merchants (manage sub-merchants) with a single account.
+## You can use the i'mport Agent service to set up PGs for sub-merchants (manage sub-merchants) with a single account.
**If you apply for and register multiple sub-merchant codes (Tier codes) with the master account,
you can register merchant information and view (cancel) payment details for each sub-merchant.**
@@ -14,13 +14,12 @@ you can register merchant information and view (cancel) payment details for each
(You can assign a 3-digit ID and a name for each sub-merchant)
-To get access to this service, send your ChaiPort email account to the following:
-
-[**cs@iamport.kr**](mailto:cs@iamport.kr)
+ To get access to this service, send your ChaiPort email account to the following:
+ [**cs@iamport.kr**](mailto:cs@iamport.kr)
-### Using Agent service
+## Using Agent service
Through i'mport Agent service, you can manage merchants more conveniently and efficiently.
@@ -49,23 +48,21 @@ You can try out the sub-merchant settings and look up payment history with the d
-**Calling sub-merchant's payment window**
-
-When requesting payment for each sub-merchant, you can specify the target **Tier** with the **JavaScript SDK.**
+ **Calling sub-merchant's payment window**
-**IMP.agency(Merchant ID, 3-digit Tier (unique) code)**
+ When requesting payment for each sub-merchant, you can specify the target **Tier** with the **JavaScript SDK.**
-`Example: IMP.agency('imp12345678', '001')`
+ **IMP.agency(Merchant ID, 3-digit Tier (unique) code)**
+ `Example: IMP.agency('imp12345678', '001')`
-**Calling REST API**
-
-When calling the REST API, you must include the Tier information in the header to request payment for the corresponding sub-merchant.
+ **Calling REST API**
-Include the following parameter in the HTTP header.
+ When calling the REST API, you must include the Tier information in the header to request payment for the corresponding sub-merchant.
-`"Tier" : "3-digit Tier code"`
+ Include the following parameter in the HTTP header.
+ `"Tier" : "3-digit Tier code"`
diff --git a/src/content/docs/en/tips/bank-codes-by-pg.mdx b/src/content/docs/en/tips/bank-codes-by-pg.mdx
index a777fc1bf..fcb95a853 100644
--- a/src/content/docs/en/tips/bank-codes-by-pg.mdx
+++ b/src/content/docs/en/tips/bank-codes-by-pg.mdx
@@ -6,118 +6,113 @@ description: ''
import Details from "~/components/gitbook/Details.astro";
-
+ - KB Kookmin Bank: 004
+ - SC First Bank: 023
+ - Kyongnam Bank: 039
+ - Gwangju Bank: 034
+ - Industrial Bank of Korea: 003
+ - Nonghyup: 011
+ - Daegu Bank: 031
+ - Busan Bank: 032
+ - Korea Development Bank: 002
+ - Saemaul Geumgo: 045
+ - Suhyup: 007
+ - Shinhan Bank: 088
+ - Credit union: 048
+ - Korea Exchange Bank: 081
+ - Woori Bank: 020
+ - Post Office: 071
+ - Jeonbuk Bank: 037
+ - Cooperative: 012
+ - Kakao Bank: 090
+ - K-Bank: 089
+ - Hana Bank: 081
+ - Citibank Korea: 027
+ - Toss Bank: 092
-
diff --git a/src/content/docs/en/tips/billing-key-issuance-by-pg.mdx b/src/content/docs/en/tips/billing-key-issuance-by-pg.mdx
index 7eabd03ce..9cda9015f 100644
--- a/src/content/docs/en/tips/billing-key-issuance-by-pg.mdx
+++ b/src/content/docs/en/tips/billing-key-issuance-by-pg.mdx
@@ -3,19 +3,19 @@ title: Billing key issuance by PG
description: ''
---
-|PG |Payment window support|API support|Supports issuance + payment in a single request (payment window only)|
+| PG |Payment window support|API support|Supports issuance + payment in a single request (payment window only)|
|:-----------:|:--------------------:|:---------:|:-------------------------------------------------------------------:|
-|KCP |O |O |X |
-|KG Inicis |O |O |X |
-|Danal |O |O |O |
-|Danal Mobile |O |O |O |
-|Kakao Pay |O |X |O |
-|Naver Pay |O |X |X |
-|NICE Payments|X |O |X |
-|JTNET |O |O |O |
-|Settlebank |X |O |X |
-|CHAI |O |X |X |
-|KICC |O |X |X |
-|Daou Data |X |O |X |
-|KG Mobilians |O |X |O |
-|Payco |O |X |X |
+| KCP | O | O | X |
+| KG Inicis | O | O | X |
+| Danal | O | O | O |
+| Danal Mobile| O | O | O |
+| Kakao Pay | O | X | O |
+| Naver Pay | O | X | X |
+|NICE Payments| X | O | X |
+| JTNET | O | O | O |
+| Settlebank | X | O | X |
+| CHAI | O | X | X |
+| KICC | O | X | X |
+| Daou Data | X | O | X |
+| KG Mobilians| O | X | O |
+| Payco | O | X | X |
diff --git a/src/content/docs/en/tips/chk.mdx b/src/content/docs/en/tips/chk.mdx
index 741c43d9e..eb05f833a 100644
--- a/src/content/docs/en/tips/chk.mdx
+++ b/src/content/docs/en/tips/chk.mdx
@@ -77,11 +77,9 @@ production failures.
## 📱Mobile phone
-- [ ] Pass all phone carrier reviews and complete approval and full/partial cancellation tests.
+- [ ] Pass all phone carrier reviews and complete approval and full/partial cancellation tests.
+ (Partial cancellation is not supported except for Inicis and KCP (separate agreement required))
- ```
- (Partial cancellation is not supported except for Inicis and KCP (separate agreement required))
- ```
- [ ] Approved transactions can only be cancelled during the month when the transaction occurred.
## 🙋 Identity verification
diff --git a/src/content/docs/en/tips/code.mdx b/src/content/docs/en/tips/code.mdx
index e951a5aae..0528b9be7 100644
--- a/src/content/docs/en/tips/code.mdx
+++ b/src/content/docs/en/tips/code.mdx
@@ -3,7 +3,7 @@ title: Courier codes
description: Courier codes required for escrow delivery registration.
---
-### The following codes apply to all PGs.
+## The following codes apply to all PGs.
|Courier code|Courier name |
|------------|---------------------------------------------------------|
@@ -25,4 +25,3 @@ description: Courier codes required for escrow delivery registration.
|HONAM |Woori Logis (Honam Logis) |
|HDEXP |Hapdong Express |
|ETC |Other (Code specified other than the above is set to ETC)|
-
diff --git a/src/content/docs/en/tips/confirm-process.mdx b/src/content/docs/en/tips/confirm-process.mdx
index ad866b825..2ac3ce494 100644
--- a/src/content/docs/en/tips/confirm-process.mdx
+++ b/src/content/docs/en/tips/confirm-process.mdx
@@ -8,19 +8,18 @@ description: >-
import Figure from "~/components/Figure.astro";
import Hint from "~/components/Hint.astro";
-### This service allows the merchant to confirm its intention to process a payment request before making the request.
+## This service allows the merchant to confirm its intention to process a payment request before making the request.
-![]()
+![]()
-**A merchant must use this service:**
-
-- When there is a small quantity of the product in stock
-- When payment is processed first-come-first-served
-- When there is business logic that the merchant wants to execute just before making the payment request
+ **A merchant must use this service:**
+ - When there is a small quantity of the product in stock
+ - When payment is processed first-come-first-served
+ - When there is business logic that the merchant wants to execute just before making the payment request
@@ -33,7 +32,7 @@ on the inventory. If the confirm process is not configured, the purchased order
scheduled due to lack of inventory or may be cancelled leading to poor customer satisfaction and
experience.
-![]()
+![]()
### When payment is processed first-come-first-served
@@ -42,20 +41,19 @@ marathon, ticketing for popular concerts, and special discount events such as OO
a rush of concurrent payment requests at the scheduled time. In such a case, the merchant needs to
perform a final inventory check on the server just before making the payment request.
-![]()
+
### When there is business logic that the merchant wants to execute just before making the payment request
The service can also be used when the merchant needs to process some business logic just before
payment for reasons, such as checking the health of the merchant server.
-![]()
+
-**How to request for Confirm Process**
-
-Send a technical support request email ([support@iamport.kr](mailto:support@iamport.kr)) with your **Merchant ID**.
+ **How to request for Confirm Process**
+ Send a technical support request email ([support@iamport.kr](mailto:support@iamport.kr)) with your **Merchant ID**.
@@ -65,10 +63,10 @@ Send a technical support request email ([support@iamport.kr](mailto:support@iamp
To use Confirm Process, you must define the **confirm\_url** parameter and set it to the merchant
endpoint URL when calling the request\_pay() function.
-```jsx title="JavaScript SDK"
-...
-confirm_url : ‘Merchant EndPoint URL’,
-...
+```json title="JavaScript SDK"
+{
+ "confirm_url": "Merchant EndPoint URL",
+}
```
If the confirm URL is set, the final confirm page before payment request is loaded via **HTTP** with
diff --git a/src/content/docs/en/tips/flow.mdx b/src/content/docs/en/tips/flow.mdx
index 1a029e8fe..937ddfcc6 100644
--- a/src/content/docs/en/tips/flow.mdx
+++ b/src/content/docs/en/tips/flow.mdx
@@ -9,23 +9,20 @@ import Figure from "~/components/Figure.astro";
## 1. Direct PG integration payment flow
-
+
> For direct PG integration, payment request processing generally involves **2 transactions**.
>
> 1. **Get authentication key** for payment request.
> 2. **Request payment**.
->
-> This requires covering several backend development points, and facing a **triple challenge** of complex integration modules and sample pages and comprehending complex and inconvenient integration manuals.
+
+> This requires covering several backend development points,
+> and facing a **triple challenge** of complex integration modules
+> and sample pages and comprehending complex and inconvenient integration manuals.
## 2. i'mport payment flow
-
+
-> For i'mport payment integration, the complex PG integration module part is handled by i'mport so that you can easily process payment without additional effort.
+> For i'mport payment integration, the complex PG integration module part is handled by i'mport
+> so that you can easily process payment without additional effort.
diff --git a/src/content/docs/en/tips/pg-codes.mdx b/src/content/docs/en/tips/pg-codes.mdx
index ca107f243..f211f06f0 100644
--- a/src/content/docs/en/tips/pg-codes.mdx
+++ b/src/content/docs/en/tips/pg-codes.mdx
@@ -31,4 +31,3 @@ description: JavaScript SDK PG codes
| Toss Simple Pay | `tosspay` |
| Smartro | `smartro` |
| Settlebank | `settle` |
-
diff --git a/src/content/docs/en/tips/redirect.mdx b/src/content/docs/en/tips/redirect.mdx
index d5470f6a5..6fb5b9f36 100644
--- a/src/content/docs/en/tips/redirect.mdx
+++ b/src/content/docs/en/tips/redirect.mdx
@@ -3,22 +3,22 @@ title: What is redirection?
description: Learn about page redirection.
---
-### Redirecting the current page to a new page.
+## Redirecting the current page to a new page.
![]()
-### Why do you need redirection?
+## Why do you need redirection?
- To redirect to the new URL when a page's URL changes
- To redirect an invalid subdomain to another domain
- To redirect to another page for log-in or authentication purposes
-### There are two types of redirections as follows:
+## There are two types of redirections as follows:
- **Redirection 301**
- \- Redirect immediately without processing any server-side or client-side code
+ \- Redirect immediately without processing any server-side or client-side code
- **Redirection 302**
- \- Redirect temporarily using a script or html tag
+ \- Redirect temporarily using a script or html tag
diff --git a/src/content/docs/en/tips/tax.mdx b/src/content/docs/en/tips/tax.mdx
index 4ade80d7b..6f2e11c3d 100644
--- a/src/content/docs/en/tips/tax.mdx
+++ b/src/content/docs/en/tips/tax.mdx
@@ -5,13 +5,13 @@ description: Learn how to set the tax-free amount when requesting a payment.
import Hint from "~/components/Hint.astro";
-This guide is intended for businesses who sell tax-free products and services as stipulated in [**Article 26 of the VAT Act (Supply of Tax-Free Goods or Services)**](https://txsi.hometax.go.kr/docs/customer/comment/comment_jomun_main_internet.jsp?node_id=null&lawid=001571&jomunkey=0026005&lawnm=%EB%B6%80%EA%B0%80%EA%B0%80%EC%B9%98%EC%84%B8%EB%B2%95&jomun_nm=%EC%A0%9C26%EC%A1%B0%E3%80%90%EC%9E%AC%ED%99%94%20%EB%98%90%EB%8A%94%20%EC%9A%A9%EC%97%AD%EC%9D%98%20%EA%B3%B5%EA%B8%89%EC%97%90%20%EB%8C%80%ED%95%9C%20%EB%A9%B4%EC%84%B8%E3%80%91&public_ilja=20161220&public_no=14387).
+This guide is intended for businesses who sell tax-free products and services as stipulated in [**Article 26 of the VAT Act (Supply of Tax-Free Goods or Services)**](https://txsi.hometax.go.kr/docs/customer/comment/comment_jomun_main_internet.jsp?node_id=null\&lawid=001571\&jomunkey=0026005\&lawnm=%EB%B6%80%EA%B0%80%EA%B0%80%EC%B9%98%EC%84%B8%EB%B2%95\&jomun_nm=%EC%A0%9C26%EC%A1%B0%E3%80%90%EC%9E%AC%ED%99%94%20%EB%98%90%EB%8A%94%20%EC%9A%A9%EC%97%AD%EC%9D%98%20%EA%B3%B5%EA%B8%89%EC%97%90%20%EB%8C%80%ED%95%9C%20%EB%A9%B4%EC%84%B8%E3%80%91\&public_ilja=20161220\&public_no=14387).
If you are a general business that does not sell the goods or services specified in this article,
you may skip this guide. A 10% VAT is automatically applied through the PG or credit card company
for such businesses.
-### Getting Tax-free Merchant ID through PG Contract
+## Getting Tax-free Merchant ID through PG Contract
If you are a **tax-free business**, you can submit a business registration card to prove your tax-exempt status when signing a PG contract. You will receive a merchant ID that allows you to set the following tax-free related properties when requesting a payment using `IMP.`**`request_pay`**.
@@ -23,13 +23,12 @@ and tax-free amounts. They set the `tax_free` property to indicate the tax-free
order.
-**Merchant ID**
-
-The name of the merchant ID issued after applying for and signing a PG contract varies by PG. For example, the merchant ID for KG INICIS is `Merchant ID (MID)`, Kakao Pay is `Member Code (CID)`, and Naver Pay is `Partner ID`.
+ **Merchant ID**
+ The name of the merchant ID issued after applying for and signing a PG contract varies by PG. For example, the merchant ID for KG INICIS is `Merchant ID (MID)`, Kakao Pay is `Member Code (CID)`, and Naver Pay is `Partner ID`.
-#### Three types of merchant IDs can be issued according to your business's tax-exempt status.
+### Three types of merchant IDs can be issued according to your business's tax-exempt status.
> **Tax-free merchant ID**
>
@@ -54,15 +53,14 @@ The name of the merchant ID issued after applying for and signing a PG contract
> property.
-**`tax_free` is required**
-
-For transactions using combination merchant ID, you must set **both the `amount` and `tax_free` properties**. If the `tax_free` value is missing, an error may occur when you attempt to open the payment page for some PGs.
+ **`tax_free` is required**
-Note that KG Inicis **processes all payments as tax-free**; if you change to a combination merchant ID while using a taxable merchant ID, all previous taxed payments are converted to tax-free payments.
+ For transactions using combination merchant ID, you must set **both the `amount` and `tax_free` properties**. If the `tax_free` value is missing, an error may occur when you attempt to open the payment page for some PGs.
+ Note that KG Inicis **processes all payments as tax-free**; if you change to a combination merchant ID while using a taxable merchant ID, all previous taxed payments are converted to tax-free payments.
-### Applying tax_free setting
+## Applying tax\_free setting
The scenarios in this section show how to set the `amount` and `tax_free` properties when purchasing
tax-free and/or taxable items.
@@ -73,20 +71,22 @@ as follows:
- Plant seedlings: **tax-free**, 11,000 won each
- Vase: **subject to VAT**, 22,000 won each
-### CASE 01. Purchasing only tax-free items
+## CASE 01. Purchasing only tax-free items
For a purchase of one seedling, set the total payment amount to 11,000 won, and the total tax-free
amount to 11,000 won as follows:
-```javascript title="JavaScript"
- IMP.request_pay({
- amount: 11000, // total payment amount
- tax_free: 11000, // total tax-free amount
- ...
- }, function (rsp) {
- ...
- });
-
+```ts title="JavaScript"
+IMP.request_pay(
+ {
+ amount: 11000, // total payment amount
+ tax_free: 11000, // total tax-free amount
+ // ...
+ },
+ function (rsp) {
+ // ...
+ },
+);
```
In this case, the total amount of 11,000 won is tax-free, and the final payment is calculated as
@@ -95,20 +95,22 @@ follows (terminology may vary by PG):
- Total tax-free amount: 11,000 won
- VAT: 0 won
-### CASE 02. Purchasing only taxable items
+## CASE 02. Purchasing only taxable items
For a purchase of one vase, set the total payment amount to 22,000 won, and the total tax-free
amount to 0 won as follows:
-```javascript title="JavaScript"
- IMP.request_pay({
- amount: 22000, // total payment amount
- tax_free: 0, // total tax-free amount
- ...
- }, function (rsp) {
- ...
- });
-
+```ts title="JavaScript"
+IMP.request_pay(
+ {
+ amount: 22000, // total payment amount
+ tax_free: 0, // total tax-free amount
+ // ...
+ },
+ function (rsp) {
+ // ...
+ },
+);
```
In this case, a 10% VAT is applied to the total amount of 22,000 won, and the final payment is
@@ -117,19 +119,22 @@ calculated as follows:
- Total item price: 20,000 won
- VAT: 2,000 won
-### CASE 03. Purchasing both tax-free and taxable items
+## CASE 03. Purchasing both tax-free and taxable items
For a purchase of 3 seedlings and 1 vase, set the total payment amount to 55,000 (33,000 + 22,000)
won, and the total tax-free amount to 33,000 won (for seedlings) as follows:
-```javascript title="JavaScript"
- IMP.request_pay({
- amount: 55000, // total payment amount
- tax_free: 33000, // total tax-free amount
- ...
- }, function (rsp) {
- ...
- });
+```ts title="JavaScript"
+IMP.request_pay(
+ {
+ amount: 55000, // total payment amount
+ tax_free: 33000, // total tax-free amount
+ // ...
+ },
+ function (rsp) {
+ // ...
+ },
+);
```
In this case, a 10% VAT is applied to the total taxable amount of 22,000 won, and the final payment
diff --git a/src/content/docs/ko/api-v2/applications.mdx b/src/content/docs/ko/api-v2/applications.mdx
index 7a420562c..b3a588ff1 100644
--- a/src/content/docs/ko/api-v2/applications.mdx
+++ b/src/content/docs/ko/api-v2/applications.mdx
@@ -8,1022 +8,952 @@ import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
## ⌨ 하위상점의 전자결제 신청 정보를 가져오기 (호스팅사 > 포트원)
-
-하위상점 등록 API를 통해서 호스팅사의 사업자 정보를 포트원에 전달하면 전자결제 신청을 위해 하위상점의 전자결제 신청 정보, 계약 진행 상태 정보를 가져옵니다.
-
-
-
-### Parameters
-
-#### Header
-
-
-jwt 토큰 헤더
-
-
-
-#### Path
-
-
-store의 id
-
-
-
-### Responses
-
-
-
-
-**`applications`** **\*** **Array\[ApplicationPublic]**
-
-전자결제 신청내역
-
-
-
ApplicationPublic
-
-**`id`** **\*** **string**
-
-전자결제 신청 id
-
----
-
-**`store_id`** **string**
-
-전자결제 신청한 store id
-
----
-
-**`pg_company`** **\*** **PgCompany**
-
-PG사
-
-`"UNIDENTIFIED"`, `"NICE"`, `"KCP"`, `"KICC"`, `"DANAL"`, `"SETTLE"`, `"JTNET"`, `"INICIS"`, `"SMARTRO"`, `"BLUEWALNUT"`, `"TOSSPAYMENTS"`, `"DAOU"`, `"KSNET"`, `"MOBILIANS"`, `"ALIPAY"`, `"EXIMBAY"`, `"PAYPAL"`, `"PAYMENTWALL"`, `"NAVERPAY"`, `"NAVERCO"`, `"KAKAOPAY"`, `"TOSSPAY"`, `"CHAI"`, `"PAYCO"`, `"SMILEPAY"`
+
+ 하위상점 등록 API를 통해서 호스팅사의 사업자 정보를 포트원에 전달하면 전자결제 신청을 위해 하위상점의 전자결제 신청 정보, 계약 진행 상태 정보를 가져옵니다.
+
----
+ ### Parameters
-**`methods`** **\*** **Array\[MethodAndType]**
+ #### Header
-해당 PG사로 신청한 결제수단 및 방식
+
+ jwt 토큰 헤더
+
-`"CARD_GENERAL"`, `"CARD_SUBSCRIBE"`, `"CARD_KEYIN"`, `"TRANS_GENERAL"`, `"VBANK_GENERAL"`, `"PHONE_GENERAL"`, `"PHONE_SUBSCRIBE"`, `"GIFT_CARD_GENERAL"`, `"ABROAD_GENERAL"`, `"MY_ACCOUNT_GENERAL"`, `"NAVERPAY_GENERAL"`, `"NAVERCO_GENERAL"`, `"KAKAOPAY_GENERAL"`, `"TOSSPAY_GENERAL"`, `"PAYCO_GENERAL"`, `"SMILEPAY_GENERAL"`, `"CERTIFICATION_PHONE"`, `"CERTIFICATION_UNIFIED"`
+ #### Path
----
+
+ store의 id
+
-**`status`** **\*** **ApplicationStatusClass**
+ ### Responses
-신청 상태 대분류
+
+
+
+ **`applications`** **\*** **Array\[ApplicationPublic]**
-`"RECEPTION_SCHEDULED"`, `"TRANSFER"`, `"RECEPTION_PENDING"`, `"RECEPTION_COMPLETED"`, `"APPLICATION_CANCELED"`, `"MERCHANT_REVIEWING"`, `"CONTRACT_PROCESSING"`, `"CONTRACT_COMPLETED"`, `"CONTRACT_CANCELED"`, `"CONTRACT_PENDING"`, `"CONTRACT_REJECTED"`, `"SERVICE_CLOSED"`, `"SERVICE_OPEN"`
+ 전자결제 신청내역
----
+
+
+
+ **`cavv`** **\*** **string**
+
+ ---
+
+ **`xid`** **\*** **string**
+
+ ---
+
+ **`eci`** **\*** **string**
+
+ ---
+
+
+ ---
+
+
+
+
+
+ **`card`** **InstantBillingKeyCardForm**
+
+ 빌링키 발급 시에 필요한 카드 관련 정보
+
+
+
InstantBillingKeyCardForm
+
+ **`card_credential`** **\*** **CardCredential**
+
+ 카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보
+
+ ---
+
+ **`cvc`** **string**
+
+ ---
+
+ **`vbv`** **VBV**
+
+ 3DS 인증 결과를 담는 객체 (Verified by Visa)
+
+ ---
+
+
+ ---
+
+ **`mobile_phone`** **MobileForm**
+
+ 휴대폰을 이용한 소액결제와 정기결제를 위한 빌링키 발급 시에 사용하는 휴대폰 관련 정보
+
+
+
-
-**`cavv`** **\*** **string**
-
----
-
-**`xid`** **\*** **string**
-
----
-
-**`eci`** **\*** **string**
-
----
-
-
-
----
-
-
-
-
-
-
-**`card`** **InstantBillingKeyCardForm**
-
-빌링키 발급 시에 필요한 카드 관련 정보
-
-
-
InstantBillingKeyCardForm
-
-**`card_credential`** **\*** **CardCredential**
-
-카드를 이용한 결제 및 빌링키 발급에 필요한 인증 관련 정보
-
----
-
-**`cvc`** **string**
-
----
-
-**`vbv`** **VBV**
-
-3DS 인증 결과를 담는 객체 (Verified by Visa)
-
----
-
-
-
----
-
-**`mobile_phone`** **MobileForm**
-
-휴대폰을 이용한 소액결제와 정기결제를 위한 빌링키 발급 시에 사용하는 휴대폰 관련 정보
-
-
-
+ **`params`** **object**
-**`code`** **\*** **string**
+ 에러 세부사항
-웹훅 응답 http 코드
+ ---
+
+
+
+
----
+## ⌨ 결제내역 다건조회
-**`header`** **\*** **object**
+
+
+ 결제내역들을 조회할 수 있는 API입니다. 실제 결제 발생 이후 조회되기까지 지연이 있으니 검증을 위해서는
-응답 header
+ [결제내역 단건조회](payment#getPayment)
----
+ 를 이용해주세요. 현재 page \* limit이 50000 이상이 되는 쿼리를 허용하지 않는 제약을 갖고있습니다. 많은 양의 데이터를 받아올 경우 날짜범위를 좁혀서 사용해주세요. 추후 50000개 이상 대량의 데이터를 한번에 편리하게 쿼리할 수 있도록 하는 수정이 예정되어있습니다.
+
-**`body`** **\*** **string**
+ ### Parameters
-응답 body
+ #### Query
----
+
+ 하위 상점 ID - Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제건을 조회합니다.
+
-**`responded_at`** **\*** **string**
+
+ 어떤 시각을 기준으로 조회를 할 것인지 선택합니다.
-응답 시각
+ - `REQUESTED_AT`: 결제 요청 시각을 기준으로 조회합니다.
----
+ - `STATUS_UPDATED_AT`: 상태 승인 시각을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다.
+ - `ready` -> 결제 요청 시각 기준
+ - `paid` -> 결제 완료 시각 기준
+ - `cancelled` -> 결제 취소 시각 기준
+ - `failed` -> 결제 실패 시각 기준
-
+ 값을 넣지 않으면 `STATUS_UPDATED_AT` 으로 자동 적용됩니다.
+
----
+
+ 결제 요청/상태 승인 시각 범위의 시작 - 값을 넣지 않으면 `end`의 90일 전으로 설정됩니다.
+
-**`triggered_at`** **string**
+
+ 결제 요청/상태 승인 시각 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.
+
-웹훅 처리 시작 시각
+
+ 결제상태 리스트 - 값을 넣지 않으면 결제상태 필터링이 적용되지 않습니다.
+
----
+
+ 결제수단 리스트 - 값을 넣지 않으면 결제수단 필터링이 적용되지 않습니다.
+
-
-
+
+ 결제대행사 리스트 - 값을 넣지 않으면 결제대행사 필터링이 적용되지 않습니다.
+
-
+
+ 테스트결제 필터링
+
-
-
-
-**`code`** **\*** **string**
+
+ 정기결제 필터링
+
-`"UNAUTHORIZED"`
+
+ 통합검색 항목
+
----
+
+ 통합검색 입력값
+
-**`params`** **object**
+
+ 페이지 - 0부터 시작합니다.
+
-에러 세부사항
+
+ 페이지 크기 (최대 1000까지 허용)
+
----
+
+ 정렬 기준
-
-
+ `REQUESTED_AT`
-
+ : 결제요청시각
-
-
-
-**`code`** **\*** **string**
+ `STATUS_UPDATED_AT`
-`"PAYMENT_NOT_FOUND"`
+ : 상태변경시각
+
----
+
+ 정렬 방향
-**`params`** **object**
+ `DESCENDING`
-에러 세부사항
+ : 내림차순
----
+ `ASCENDING`
-
-
+ : 오름차순
+
-
+ ### Responses
-
-
-
-**`code`** **\*** **string**
+
+
+
+ **`current_page`** **\*** **integer**
-`"PORTONE_ERROR"`
+ ---
----
+ **`total_page`** **\*** **integer**
-**`params`** **object**
+ ---
-에러 세부사항
+ **`total_count`** **\*** **integer**
----
+ ---
-
-
+ **`payments`** **\*** **Array\[Payment]**
-
+ 결제내역
-
+
+
Payment
-## ⌨ 결제내역 다건조회
+ **`id`** **\*** **string**
-
-
-결제내역들을 조회할 수 있는 API입니다. 실제 결제 발생 이후 조회되기까지 지연이 있으니 검증을 위해서는
+ 고객사에서 입력한 결제 ID
-[결제내역 단건조회](payment#getPayment)
+ ---
-를 이용해주세요. 현재 page \* limit이 50000 이상이 되는 쿼리를 허용하지 않는 제약을 갖고있습니다. 많은 양의 데이터를 받아올 경우 날짜범위를 좁혀서 사용해주세요. 추후 50000개 이상 대량의 데이터를 한번에 편리하게 쿼리할 수 있도록 하는 수정이 예정되어있습니다.
+ **`merchant_id`** **\*** **string**
-
+ 고객사 ID
-### Parameters
+ ---
-#### Query
+ **`store_id`** **\*** **string**
-
-하위 상점 ID - Merchant 사용자만 사용가능하며, 지정되지 않은 경우 고객사 전체 결제건을 조회합니다.
+ 하위 상점 ID
-
-
-어떤 시각을 기준으로 조회를 할 것인지 선택합니다.
+ ---
-- `REQUESTED_AT`: 결제 요청 시각을 기준으로 조회합니다.
-- `STATUS_UPDATED_AT`: 상태 승인 시각을 기준으로 조회합니다. 결제 건의 최종 상태에 따라 검색 기준이 다르게 적용됩니다.
- - `ready` -> 결제 요청 시각 기준
- - `paid` -> 결제 완료 시각 기준
- - `cancelled` -> 결제 취소 시각 기준
- - `failed` -> 결제 실패 시각 기준
+ **`transactions`** **\*** **Array\[Transaction]**
-값을 넣지 않으면 `STATUS_UPDATED_AT` 으로 자동 적용됩니다.
+ 동일한 `payment_id`로 결제시도된 결제내역들
-
-
-결제 요청/상태 승인 시각 범위의 시작 - 값을 넣지 않으면 `end`의 90일 전으로 설정됩니다.
+ ---
+
-
-
-결제 요청/상태 승인 시각 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.
+ ---
+
-
-
-결제상태 리스트 - 값을 넣지 않으면 결제상태 필터링이 적용되지 않습니다.
+
+ **`detail`** **CardDetail**
-
-
-결제수단 리스트 - 값을 넣지 않으면 결제수단 필터링이 적용되지 않습니다.
+ 카드 정보
-
-
-결제대행사 리스트 - 값을 넣지 않으면 결제대행사 필터링이 적용되지 않습니다.
+
+
+ **`status`** **\*** **TransactionStatus**
-**`detail`** **CardDetail**
+ 결제 건의 상태를 나타내는 enum string
-카드 정보
+ `"READY"`, `"PENDING"`, `"VIRTUAL_ACCOUNT_ISSUED"`, `"PAID"`, `"FAILED"`, `"PARTIAL_CANCELLED"`, `"CANCELLED"`
----
+ ---
-**`number`** **string**
+ **`amount`** **\*** **TransactionAmount**
-마스킹된 카드 번호
+ 결제 금액 및 통화 관련 세부 정보
----
+
+
-`"NORMAL"`, `"FIXED"`
+ **`cavv`** **\*** **string**
----
+ ---
-**`pg_account_id`** **string**
+ **`xid`** **\*** **string**
-고정식 가상계좌 방식에서, 고객사가 가상계좌 번호를 관리하지 않고 PG사가 pg_account_id에 매핑되는 가상계좌 번호를 내려줄 때 사용하는 필드입니다. 동일한 pg_account_id로 가상계좌 발급 요청시에는 항상 같은 가상계좌 번호가 내려옵니다. account_type이 FIXED일 때만 유효하며, account_number 필드와 함께 사용할 수 없습니다.
+ ---
----
+ **`eci`** **\*** **string**
-**`account_number`** **string**
+ ---
+
-고정식 가상계좌 방식에서, PG사로부터 일정 갯수의 가상계좌 번호를 미리 전달받았을 때 사용하는 필드입니다. 고객사로부터 전달받은 가상계좌 번호를 직접 입력하면 됩니다. account_type이 FIXED일 때만 유효하며, pg_account_id 필드와 함께 사용할 수 없습니다.
+ ---
----
+ **`card_installment_plan`** **integer**
-**`cash_receipt_form`** **object**
+ 카드 할부 개월 수
-현금영수증 발급을 위해 필요한 정보
+ ---
----
+ **`use_free_installment_plan`** **boolean**
-**`remittee_name`** **string**
+ 무이자 할부 적용 여부
-예금주명
+ ---
----
+ **`use_free_interest_from_mall`** **boolean**
-
+ ---
+
----
+
+ **`card`** **InstantCardForm**
-
+ 카드를 이용한 결제 & 빌링키 발급 시에 필요한 카드 관련 정보
-
-**`bank`** **\*** **Bank**
+
+
+ **`vbv`** **VBV**
-**`valid_hours`** **integer**
+ 3DS 인증 결과를 담는 객체 (Verified by Visa)
----
+ ---
-**`due_date`** **string**
+ **`card_installment_plan`** **integer**
----
+ 카드 할부 개월 수
-
+ ---
----
+ **`use_free_installment_plan`** **boolean**
-**`account_type`** **\*** **virtual_account_type_VirtualAccountType**
+ 무이자 할부 적용 여부
-가상계좌 유형(일반 or 고정)
+ ---
-`"NORMAL"`, `"FIXED"`
+ **`use_free_interest_from_mall`** **boolean**
----
+ ---
+
-**`pg_account_id`** **string**
+ ---
-고정식 가상계좌 방식에서, 고객사가 가상계좌 번호를 관리하지 않고 PG사가 pg_account_id에 매핑되는 가상계좌 번호를 내려줄 때 사용하는 필드입니다. 동일한 pg_account_id로 가상계좌 발급 요청시에는 항상 같은 가상계좌 번호가 내려옵니다. account_type이 FIXED일 때만 유효하며, account_number 필드와 함께 사용할 수 없습니다.
+ **`virtual_account`** **InstantVirtualAccountForm**
----
+ 가상계좌 발급을 위해 필요한 가상계좌 발급 관련 정보
-**`account_number`** **string**
+
+
InstantVirtualAccountForm
-고정식 가상계좌 방식에서, PG사로부터 일정 갯수의 가상계좌 번호를 미리 전달받았을 때 사용하는 필드입니다. 고객사로부터 전달받은 가상계좌 번호를 직접 입력하면 됩니다. account_type이 FIXED일 때만 유효하며, pg_account_id 필드와 함께 사용할 수 없습니다.
+ **`bank`** **\*** **Bank**
----
+ 은행
-**`cash_receipt_form`** **object**
+ `"BANK_OF_KOREA"`, `"KOREA_DEVELOPMENT_BANK"`, `"INDUSTRIAL_BANK_OF_KOREA"`, `"KOOKMIN_BANK"`, `"SUHYUP_BANK"`, `"EXPORT_IMPORT_BANK_OF_KOREA"`, `"NH_NONGHYUP_BANK"`, `"LOCAL_NONGHYUP"`, `"WOORI_BANK"`, `"SC_BANK_KOREA"`, `"CITI_BANK_KOREA"`, `"DAEGU_BANK"`, `"BUSAN_BANK"`, `"GWANGJU_BANK"`, `"JEJU_BANK"`, `"JEONBUK_BANK"`, `"KYONGNAM_BANK"`, `"KFCC"`, `"SHINHYUP"`, `"SAVINGS_BANK_KOREA"`, `"MORGAN_STANLEY_BANK"`, `"HSBC_BANK"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN_CHASE_BANK"`, `"MIZUHO_BANK"`, `"MUFG_BANK"`, `"BANK_OF_AMERICA_BANK"`, `"BNP_PARIBAS_BANK"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"NATIONAL_FORESTRY_COOPERATIVE_FEDERATION"`, `"UNITED_OVERSEAS_BANK"`, `"BANK_OF_COMMUNICATIONS"`, `"CHINA_CONSTRUCTION_BANK"`, `"EPOST"`, `"KODIT"`, `"KIBO"`, `"HANA_BANK"`, `"SHINHAN_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`, `"KCIS"`, `"DAISHIN_SAVINGS_BANK"`, `"SBI_SAVINGS_BANK"`, `"HK_SAVINGS_BANK"`, `"WELCOME_SAVINGS_BANK"`, `"SHINHAN_SAVINGS_BANK"`, `"KYOBO_SECURITIES"`, `"DAISHIN_SECURITIES"`, `"MERITZ_SECURITIES"`, `"MIRAE_ASSET_SECURITIES"`, `"BOOKOOK_SECURITIES"`, `"SAMSUNG_SECURITIES"`, `"SHINYOUNG_SECURITIES"`, `"SHINHAN_FINANCIAL_INVESTMENT"`, `"YUANTA_SECURITIES"`, `"EUGENE_INVESTMENT_SECURITIES"`, `"KAKAO_PAY_SECURITIES"`, `"TOSS_SECURITIES"`, `"KOREA_FOSS_SECURITIES"`, `"HANA_FINANCIAL_INVESTMENT"`, `"HI_INVESTMENT_SECURITIES"`, `"KOREA_INVESTMENT_SECURITIES"`, `"HANWHA_INVESTMENT_SECURITIES"`, `"HYUNDAI_MOTOR_SECURITIES"`, `"DB_FINANCIAL_INVESTMENT"`, `"KB_SECURITIES"`, `"KTB_INVESTMENT_SECURITIES"`, `"NH_INVESTMENT_SECURITIES"`, `"SK_SECURITIES"`, `"SGI"`, `"KIWOOM_SECURITIES"`, `"EBEST_INVESTMENT_SECURITIES"`, `"CAPE_INVESTMENT_CERTIFICATE"`
-현금영수증 발급을 위해 필요한 정보
+ ---
-
-
cash_receipt_form
+ **`account_expiry`** **\*** **object**
-**`receipt_type`** **\*** **cash_receipt_type_CashReceiptType**
+ valid\_hours와 due\_date 둘 중 하나의 값만 채워야 함
-현금영수증 용도. personal = 소득공제용, corporate = 지출증빙용, anonymous = 국세청번호 자동발급 케이스
+ ---
-`"PERSONAL"`, `"CORPORATE"`, `"ANONYMOUS"`
+ **`account_type`** **\*** **virtual\_account\_type\_VirtualAccountType**
----
+ 가상계좌 유형(일반 or 고정)
-**`registration_number`** **\*** **string**
+ `"NORMAL"`, `"FIXED"`
-현금영수증 신청 번호
+ ---
----
+ **`pg_account_id`** **string**
-**`business_number`** **string**
+ 고정식 가상계좌 방식에서, 고객사가 가상계좌 번호를 관리하지 않고 PG사가 pg\_account\_id에 매핑되는 가상계좌 번호를 내려줄 때 사용하는 필드입니다. 동일한 pg\_account\_id로 가상계좌 발급 요청시에는 항상 같은 가상계좌 번호가 내려옵니다. account\_type이 FIXED일 때만 유효하며, account\_number 필드와 함께 사용할 수 없습니다.
-현금영수증을 발급할 사업자등록번호
+ ---
----
+ **`account_number`** **string**
-
+ 고정식 가상계좌 방식에서, PG사로부터 일정 갯수의 가상계좌 번호를 미리 전달받았을 때 사용하는 필드입니다. 고객사로부터 전달받은 가상계좌 번호를 직접 입력하면 됩니다. account\_type이 FIXED일 때만 유효하며, pg\_account\_id 필드와 함께 사용할 수 없습니다.
----
+ ---
-**`remittee_name`** **string**
+ **`cash_receipt_form`** **object**
-예금주명
+ 현금영수증 발급을 위해 필요한 정보
----
+ ---
-
-
+ **`remittee_name`** **string**
-
-
-**`id`** **\*** **string**
+ 예금주명
----
+ ---
+
-**`name`** **\*** **string**
+ ---
+
----
+
+ **`bank`** **\*** **Bank**
-**`tag`** **string**
+ 은행
----
+ `"BANK_OF_KOREA"`, `"KOREA_DEVELOPMENT_BANK"`, `"INDUSTRIAL_BANK_OF_KOREA"`, `"KOOKMIN_BANK"`, `"SUHYUP_BANK"`, `"EXPORT_IMPORT_BANK_OF_KOREA"`, `"NH_NONGHYUP_BANK"`, `"LOCAL_NONGHYUP"`, `"WOORI_BANK"`, `"SC_BANK_KOREA"`, `"CITI_BANK_KOREA"`, `"DAEGU_BANK"`, `"BUSAN_BANK"`, `"GWANGJU_BANK"`, `"JEJU_BANK"`, `"JEONBUK_BANK"`, `"KYONGNAM_BANK"`, `"KFCC"`, `"SHINHYUP"`, `"SAVINGS_BANK_KOREA"`, `"MORGAN_STANLEY_BANK"`, `"HSBC_BANK"`, `"DEUTSCHE_BANK"`, `"JP_MORGAN_CHASE_BANK"`, `"MIZUHO_BANK"`, `"MUFG_BANK"`, `"BANK_OF_AMERICA_BANK"`, `"BNP_PARIBAS_BANK"`, `"ICBC"`, `"BANK_OF_CHINA"`, `"NATIONAL_FORESTRY_COOPERATIVE_FEDERATION"`, `"UNITED_OVERSEAS_BANK"`, `"BANK_OF_COMMUNICATIONS"`, `"CHINA_CONSTRUCTION_BANK"`, `"EPOST"`, `"KODIT"`, `"KIBO"`, `"HANA_BANK"`, `"SHINHAN_BANK"`, `"K_BANK"`, `"KAKAO_BANK"`, `"TOSS_BANK"`, `"KCIS"`, `"DAISHIN_SAVINGS_BANK"`, `"SBI_SAVINGS_BANK"`, `"HK_SAVINGS_BANK"`, `"WELCOME_SAVINGS_BANK"`, `"SHINHAN_SAVINGS_BANK"`, `"KYOBO_SECURITIES"`, `"DAISHIN_SECURITIES"`, `"MERITZ_SECURITIES"`, `"MIRAE_ASSET_SECURITIES"`, `"BOOKOOK_SECURITIES"`, `"SAMSUNG_SECURITIES"`, `"SHINYOUNG_SECURITIES"`, `"SHINHAN_FINANCIAL_INVESTMENT"`, `"YUANTA_SECURITIES"`, `"EUGENE_INVESTMENT_SECURITIES"`, `"KAKAO_PAY_SECURITIES"`, `"TOSS_SECURITIES"`, `"KOREA_FOSS_SECURITIES"`, `"HANA_FINANCIAL_INVESTMENT"`, `"HI_INVESTMENT_SECURITIES"`, `"KOREA_INVESTMENT_SECURITIES"`, `"HANWHA_INVESTMENT_SECURITIES"`, `"HYUNDAI_MOTOR_SECURITIES"`, `"DB_FINANCIAL_INVESTMENT"`, `"KB_SECURITIES"`, `"KTB_INVESTMENT_SECURITIES"`, `"NH_INVESTMENT_SECURITIES"`, `"SK_SECURITIES"`, `"SGI"`, `"KIWOOM_SECURITIES"`, `"EBEST_INVESTMENT_SECURITIES"`, `"CAPE_INVESTMENT_CERTIFICATE"`
-**`code`** **string**
+ ---
----
+ **`account_expiry`** **\*** **object**
-**`quantity`** **\*** **integer**
+ valid\_hours와 due\_date 둘 중 하나의 값만 채워야 함
----
+
+
----
+ **`address_line_1`** **\*** **string**
-
-
+ 주소1
-## ⌨ 에스크로 구매완료
+ ---
-
-
+ **`address_line_2`** **\*** **string**
-
+ 주소2
-### Parameters
+ ---
-#### Path
+ **`city`** **string**
-
-결제 ID
+ 도시
-
+ ---
-#### Body
+ **`province`** **string**
-
+ 주, 도, 시
-
-
+ ---
-
+ **`country`** **country\_Country**
-### Responses
+ 국가
-
-
-
-**`completed_at`** **\*** **string**
+ `"AF"`, `"AX"`, `"AL"`, `"DZ"`, `"AS"`, `"AD"`, `"AO"`, `"AI"`, `"AQ"`, `"AG"`, `"AR"`, `"AM"`, `"AW"`, `"AU"`, `"AT"`, `"AZ"`, `"BH"`, `"BS"`, `"BD"`, `"BB"`, `"BY"`, `"BE"`, `"BZ"`, `"BJ"`, `"BM"`, `"BT"`, `"BO"`, `"BQ"`, `"BA"`, `"BW"`, `"BV"`, `"BR"`, `"IO"`, `"BN"`, `"BG"`, `"BF"`, `"BI"`, `"KH"`, `"CM"`, `"CA"`, `"CV"`, `"KY"`, `"CF"`, `"TD"`, `"CL"`, `"CN"`, `"CX"`, `"CC"`, `"CO"`, `"KM"`, `"CG"`, `"CD"`, `"CK"`, `"CR"`, `"CI"`, `"HR"`, `"CU"`, `"CW"`, `"CY"`, `"CZ"`, `"DK"`, `"DJ"`, `"DM"`, `"DO"`, `"EC"`, `"EG"`, `"SV"`, `"GQ"`, `"ER"`, `"EE"`, `"ET"`, `"FK"`, `"FO"`, `"FJ"`, `"FI"`, `"FR"`, `"GF"`, `"PF"`, `"TF"`, `"GA"`, `"GM"`, `"GE"`, `"DE"`, `"GH"`, `"GI"`, `"GR"`, `"GL"`, `"GD"`, `"GP"`, `"GU"`, `"GT"`, `"GG"`, `"GN"`, `"GW"`, `"GY"`, `"HT"`, `"HM"`, `"VA"`, `"HN"`, `"HK"`, `"HU"`, `"IS"`, `"IN"`, `"ID"`, `"IR"`, `"IQ"`, `"IE"`, `"IM"`, `"IL"`, `"IT"`, `"JM"`, `"JP"`, `"JE"`, `"JO"`, `"KZ"`, `"KE"`, `"KI"`, `"KP"`, `"KR"`, `"KW"`, `"KG"`, `"LA"`, `"LV"`, `"LB"`, `"LS"`, `"LR"`, `"LY"`, `"LI"`, `"LT"`, `"LU"`, `"MO"`, `"MK"`, `"MG"`, `"MW"`, `"MY"`, `"MV"`, `"ML"`, `"MT"`, `"MH"`, `"MQ"`, `"MR"`, `"MU"`, `"YT"`, `"MX"`, `"FM"`, `"MD"`, `"MC"`, `"MN"`, `"ME"`, `"MS"`, `"MA"`, `"MZ"`, `"MM"`, `"NA"`, `"NR"`, `"NP"`, `"NL"`, `"NC"`, `"NZ"`, `"NI"`, `"NE"`, `"NG"`, `"NU"`, `"NF"`, `"MP"`, `"NO"`, `"OM"`, `"PK"`, `"PW"`, `"PS"`, `"PA"`, `"PG"`, `"PY"`, `"PE"`, `"PH"`, `"PN"`, `"PL"`, `"PT"`, `"PR"`, `"QA"`, `"RE"`, `"RO"`, `"RU"`, `"RW"`, `"BL"`, `"SH"`, `"KN"`, `"LC"`, `"MF"`, `"PM"`, `"VC"`, `"WS"`, `"SM"`, `"ST"`, `"SA"`, `"SN"`, `"RS"`, `"SC"`, `"SL"`, `"SG"`, `"SX"`, `"SK"`, `"SI"`, `"SB"`, `"SO"`, `"ZA"`, `"GS"`, `"SS"`, `"ES"`, `"LK"`, `"SD"`, `"SR"`, `"SJ"`, `"SZ"`, `"SE"`, `"CH"`, `"SY"`, `"TW"`, `"TJ"`, `"TZ"`, `"TH"`, `"TL"`, `"TG"`, `"TK"`, `"TO"`, `"TT"`, `"TN"`, `"TR"`, `"TM"`, `"TC"`, `"TV"`, `"UG"`, `"UA"`, `"AE"`, `"GB"`, `"US"`, `"UM"`, `"UY"`, `"UZ"`, `"VU"`, `"VE"`, `"VN"`, `"VG"`, `"VI"`, `"WF"`, `"EH"`, `"YE"`, `"ZM"`, `"ZW"`
----
+ ---
+
-
+ ---
+
-
-
-
-
-
-**`code`** **\*** **string**
+## ⌨ 에스크로 구매완료
-`INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\
-`NOT_PAID`: 지불되지 않은 결제 건입니다.\
+
+
-`"INVALID_REQUEST"`, `"NOT_PAID"`
+ ### Parameters
----
+ #### Path
-**`params`** **object**
+
+ 결제 ID
+
-에러 상세 정보를 담은 파라미터 모음
+ #### Body
----
+
-
-
+
-
+ ### Responses
-
-
-
-**`code`** **\*** **string**
+
+
+
+ **`completed_at`** **\*** **string**
-`UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\
+ ---
+
+
+
-`"UNAUTHORIZED"`
+
+
+
+ **`code`** **\*** **string**
----
+ `INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\
+ `NOT_PAID`: 지불되지 않은 결제 건입니다.\\
-**`params`** **object**
+ `"INVALID_REQUEST"`, `"NOT_PAID"`
-에러 상세 정보를 담은 파라미터 모음
+ ---
----
+ **`params`** **object**
-
-
+ 에러 상세 정보를 담은 파라미터 모음
-
+ ---
+
+
+
-
-
-
-**`code`** **\*** **string**
+
+
+
+ **`code`** **\*** **string**
-`PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\
+ `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\
-`"PERMISSION_DENIED"`
+ `"UNAUTHORIZED"`
----
+ ---
-**`params`** **object**
+ **`params`** **object**
-에러 상세 정보를 담은 파라미터 모음
+ 에러 상세 정보를 담은 파라미터 모음
----
+ ---
+
+
+
-
-
+
+
+
+ **`code`** **\*** **string**
-
+ `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\
-
-
-
-**`code`** **\*** **string**
+ `"PERMISSION_DENIED"`
-`STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\
-`PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\
+ ---
-`"STORE_NOT_FOUND"`, `"PAYMENT_NOT_FOUND"`
+ **`params`** **object**
----
+ 에러 상세 정보를 담은 파라미터 모음
-**`params`** **object**
+ ---
+
+
+
-에러 상세 정보를 담은 파라미터 모음
+
+
+
+ **`code`** **\*** **string**
----
+ `STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\
+ `PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\\
-
-
+ `"STORE_NOT_FOUND"`, `"PAYMENT_NOT_FOUND"`
-
+ ---
-
-
-
-**`code`** **\*** **string**
+ **`params`** **object**
-`"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"`
+ 에러 상세 정보를 담은 파라미터 모음
----
+ ---
+
+
+
-**`params`** **object**
+
+
+
+ **`code`** **\*** **string**
-에러 상세 정보를 담은 파라미터 모음
+ `"PORTONE_ERROR"`, `"PG_PROVIDER_ERROR"`
----
+ ---
-
-
+ **`params`** **object**
-
+ 에러 상세 정보를 담은 파라미터 모음
+ ---
+
+
+
## - 가상계좌 말소
-
-
-
+
-### Parameters
+ ### Parameters
-#### Path
+ #### Path
결제 ID
-
+
#### Query
-{" "}
+ {" "}
-
- 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가
- 입력됩니다.
-
+
+ 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가
+ 입력됩니다.
+
@@ -10548,11 +10147,9 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
동일한 `payment_id`로 결제시도된 결제내역들
---
-
---
-
@@ -10610,7 +10207,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
카드전표인자명
---
-
---
@@ -10645,7 +10241,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
무이자할부 여부
---
-
---
@@ -10655,7 +10250,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
카드 포인트 사용여부
---
-
@@ -10706,7 +10300,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
카드전표인자명
---
-
@@ -10754,7 +10347,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
카드 포인트 사용여부
---
-
---
@@ -10771,7 +10363,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
표준 은행 코드 (계좌 이체시 입력됨)
---
-
---
@@ -10788,11 +10379,9 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
표준 은행 코드
---
-
---
-
@@ -10809,7 +10398,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
상품권 승인번호
---
-
@@ -10824,7 +10412,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
무이자할부 여부
---
-
@@ -10841,7 +10428,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
휴대전화번호
---
-
@@ -10876,7 +10462,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
상세 주소
---
-
@@ -10956,7 +10541,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
PG사에 등록된 고객사 ID
---
-
---
@@ -10973,19 +10557,18 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
---
- **`notifications`** **Array\[notification_Notification]**
+ **`notifications`** **Array\[notification\_Notification]**
웹훅 발송 내역
-
notification_Notification
+
notification\_Notification
**`webhook`** **Webhook**
웹훅 정보
---
-
---
@@ -11078,7 +10661,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
취소 금액 중 면세 금액
---
-
---
@@ -11143,7 +10725,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
구매자 우편번호
---
-
---
@@ -11180,7 +10761,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
결제근원의 IP 주소
---
-
---
@@ -11235,7 +10815,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
배송등록 처리 일자
---
-
---
@@ -11282,7 +10861,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
주문 수량
---
-
---
@@ -11335,7 +10913,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
PG사 전달 에러 메세지
---
-
---
@@ -11402,7 +10979,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
간편결제 정보 (충전식 간편결제일 경우 card와 transfer 값이 null임)
---
-
---
@@ -11479,7 +11055,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
영수증 url
---
-
---
@@ -11546,7 +11121,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
`"REQUESTED"`, `"FAILED"`, `"SUCCEEDED"`
---
-
---
@@ -11556,7 +11130,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
결제취소시각 - `status`가 `CANCELLED`인 경우 제공됩니다.
---
-
@@ -11565,7 +11138,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
표준 은행 코드
---
-
@@ -11620,7 +11192,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
`"PENDING"`, `"PARTIAL_FAILED"`, `"FAILED"`, `"COMPLETED"`
---
-
@@ -11702,7 +11273,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
요청 시각
---
-
---
@@ -11737,7 +11307,6 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
응답 시각
---
-
---
@@ -11747,10 +11316,8 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
웹훅 처리 시작 시각
---
-
-
@@ -11759,7 +11326,7 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
**`code`** **\*** **string**
`INVALID_REQUEST`: 파라미터를 포함한 요청을 처리하는 데에 실패했습니다. 올바른 형식의 파라미터를 전송했는지 확인해주세요.\
- `NOT_PAID`: 지불되지 않은 결제 건입니다.\
+ `NOT_PAID`: 지불되지 않은 결제 건입니다.\\
`"INVALID_REQUEST"`, `"NOT_PAID"`
@@ -11770,10 +11337,8 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
에러 상세 정보를 담은 파라미터 모음
---
-
-
@@ -11781,7 +11346,7 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
**`code`** **\*** **string**
- `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\
+ `UNAUTHORIZED`: 권한이 없습니다. 올바른 API Key를 헤더에 제공했는지 확인해주세요.\\
`"UNAUTHORIZED"`
@@ -11792,10 +11357,8 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
에러 상세 정보를 담은 파라미터 모음
---
-
-
@@ -11803,7 +11366,7 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
**`code`** **\*** **string**
- `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\
+ `PERMISSION_DENIED`: 해당 요청을 수행하기 위한 권한이 없습니다.\\
`"PERMISSION_DENIED"`
@@ -11814,10 +11377,8 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
에러 상세 정보를 담은 파라미터 모음
---
-
-
@@ -11826,7 +11387,7 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
**`code`** **\*** **string**
`STORE_NOT_FOUND`: 하위 상점을 찾을 수 없습니다.\
- `PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\
+ `PAYMENT_NOT_FOUND`: 해당하는 결제를 찾을 수 없습니다.\\
`"STORE_NOT_FOUND"`, `"PAYMENT_NOT_FOUND"`
@@ -11837,10 +11398,8 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
에러 상세 정보를 담은 파라미터 모음
---
-
-
@@ -11857,9 +11416,7 @@ valid_hours와 due_date 둘 중 하나의 값만 채워야 함
에러 상세 정보를 담은 파라미터 모음
---
-
-
diff --git a/src/content/docs/ko/api-v2/schedule.mdx b/src/content/docs/ko/api-v2/schedule.mdx
index de639f2dc..11130c12e 100644
--- a/src/content/docs/ko/api-v2/schedule.mdx
+++ b/src/content/docs/ko/api-v2/schedule.mdx
@@ -8,929 +8,885 @@ import Swagger from "~/components/gitbook/swagger/Swagger.astro";
import SwaggerDescription from "~/components/gitbook/swagger/SwaggerDescription.astro";
import SwaggerParameter from "~/components/gitbook/swagger/SwaggerParameter.astro";
import SwaggerResponse from "~/components/gitbook/swagger/SwaggerResponse.astro";
-import Tabs from "~/components/gitbook/tabs/Tabs.astro";
import Tab from "~/components/gitbook/tabs/Tab.astro";
+import Tabs from "~/components/gitbook/tabs/Tabs.astro";
## ⌨ 정기결제예약 다건 조회
-
+
-
+ ### Parameters
-### Parameters
+ #### Query
-#### Query
+
+ 하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
+
-
-하위 상점 ID - 값을 넣지 않으면 Merchant 유저의 기본값으로 설정된 상점의 id가 입력됩니다.
+
+ 결제예약시각(
-
-
-결제예약시각(
+ `scheduled_at`
-`scheduled_at`
+ ) 범위의 시작 - 값을 넣지 않으면 파라미터 end의 90일 전으로 설정됩니다.
+
-) 범위의 시작 - 값을 넣지 않으면 파라미터 end의 90일 전으로 설정됩니다.
+
+ 결제예약시각(
-
-
-결제예약시각(
+ `scheduled_at`
-`scheduled_at`
+ ) 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.
+
-) 범위의 끝 - 값을 넣지 않으면 현재 시각으로 설정됩니다.
+
+ 결제예약 상태 리스트
+
-
-
-결제예약 상태 리스트
+
+ 페이지 - 0부터 시작합니다.
+
-
-
-페이지 - 0부터 시작합니다.
+
+ 페이지 크기 (최대 1000까지 허용)
+
-
-
-페이지 크기 (최대 1000까지 허용)
+ ### Responses
-
+
+
+
+ **`current_page`** **\*** **integer**
-### Responses
+ ---
-
-
-
-**`current_page`** **\*** **integer**
+ **`total_page`** **\*** **integer**
----
+ ---
-**`total_page`** **\*** **integer**
+ **`total_count`** **\*** **integer**
----
+ ---
-**`total_count`** **\*** **integer**
+ **`schedules`** **\*** **Array\[Schedule]**
----
+ 결제예약정보
-**`schedules`** **\*** **Array\[Schedule]**
+
+
.png)
+ When paying with Hana card/NH Apps Cache (account transfer) in Safari,
+ the message below (the session has expired and the connection with the card company has been terminated)
+ is displayed and payment cannot be processed.
-If you are experiencing this, make sure that the `Prevent cross-site tracking` and `Block all cookies` options are not checked in Safari Preferences as shown below, and then try again.
+ .png)
+ If you are experiencing this, make sure that the `Prevent cross-site tracking` and `Block all cookies` options
+ are not checked in Safari Preferences as shown below, and then try again.
+ .png)
+ If you click the Next button after selecting BC Card in the credit card payment window,
+ “Payment failed” alert message is displayed and you cannot proceed any further.
+ In other browsers (Chrome, Opera, Edge, etc.) or when using other credit cards,
+ the Facebook QR code for BC card payment is rendered without any problem.
-If you are experiencing this, make sure that pop-ups are allowed for the `*.payjoa.co.kr` domain in Safari Preferences as shown below, and then try again.
+ .png)
+ If you are experiencing this, make sure that pop-ups are allowed for the `*.payjoa.co.kr` domain
+ in Safari Preferences as shown below, and then try again.
+ .png)
-
-.png)
+ .png)
+ ### Customer's phone number is not automatically filled in the escrow payment window
-- Unlike other payment windows, the customer's phone number (`buyer_tel`) passed into IMP.request_pay is not automatically filled in the escrow payment window. Note that PAYJOA does not support this function.
+ 
+ When you close the identity verification pop-up window or click the Cancel button on the page in the pop-up mode, the callback (handler) of `IMP.certification(param, handler)` is invoked. This fix implements the same behavior for when the X button is clicked.
+  (2).png)
+
 (2) (1) (1).png)
+