Skip to content

Commit

Permalink
chore: edit pgCode, pgMessage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
finalchild committed Nov 12, 2024
1 parent ee7f81d commit de9bf52
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 37 deletions.
24 changes: 14 additions & 10 deletions src/routes/(root)/opi/ko/integration/start/v2/checkout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,13 @@ async function requestPayment() {

결과값에 들어 있는 필드는 다음과 같습니다.

|필드명 |설명 |비고 |
|---------|----------|-------|
|paymentId|결제 건 ID|공통 |
|code |오류 코드 |실패 시|
|message |오류 문구 |실패 시|
|필드명 |설명 |비고 |
|---------|-------------------|----------------------------|
|paymentId|결제 건 ID |공통 |
|code |오류 코드 |실패 시 |
|message |오류 문구 |실패 시 |
|pgCode |PG 오류 코드 그대로|실패 및 PG 오류 코드 존재 시|
|pgMessage|PG 오류 문구 그대로|실패 및 PG 오류 문구 존재 시|

### 3-1. redirect 방식의 경우

Expand All @@ -116,11 +118,13 @@ PortOne.requestPayment({

쿼리 문자열로 전달되는 내용은 다음과 같습니다.

||설명 |비고 |
|---------|----------|-------|
|paymentId|결제 건 ID|공통 |
|code |오류 코드 |실패 시|
|message |오류 문구 |실패 시|
||설명 |비고 |
|---------|-------------------|----------------------------|
|paymentId|결제 건 ID |공통 |
|code |오류 코드 |실패 시 |
|message |오류 문구 |실패 시 |
|pgCode |PG 오류 코드 그대로|실패 및 PG 오류 코드 존재 시|
|pgMessage|PG 오류 문구 그대로|실패 및 PG 오류 문구 존재 시|

예를 들어 paymentId가 `payment-39ecfa97`, redirectUrl이 `https://example.com/payment-redirect`인 경우,
결제 성공 시에 `https://example.com/payment-redirect?paymentId=payment-39ecfa97`로 리다이렉트됩니다.
Expand Down
16 changes: 8 additions & 8 deletions src/routes/(root)/sdk/ko/v2-sdk/billing-key-response.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,24 @@ versionVariants:

### **`code`** <mark style="color:green;">**string**</mark>

**에러 코드**
**오류 코드**

- 에러가 있는 경우 에러 코드입니다.
- 실패한 경우 오류 코드입니다.

### **`message`** <mark style="color:green;">**string**</mark>

**에러 메시지**
**오류 메시지**

- 에러가 있는 경우 에러 메시지입니다.
- 실패한 경우 오류 메시지입니다.

### **`pgCode`** <mark style="color:green;">**string**</mark>

**PG 에러 코드**
**PG 오류 코드**

- PG에서 에러 코드를 내려 주는 경우 이 에러 코드를 그대로 반환합니다.
- PG에서 오류 코드를 내려 주는 경우 이 오류 코드를 그대로 반환합니다.

### **`pgMessage`** <mark style="color:green;">**string**</mark>

**PG 에러 메시지**
**PG 오류 메시지**

- PG에서 에러 메시지를 내려 주는 경우 이 에러 메시지를 그대로 반환합니다.
- PG에서 오류 메시지를 내려 주는 경우 이 오류 메시지를 그대로 반환합니다.
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,30 @@ versionVariants:

### **`identityVerificationTxId`** <mark style="color:green;">**string**</mark>

**포트원에서 채번한 본인인증 트랜잭션 ID**
**본인인증 시도 고유 번호**

- 포트원에서 채번하는 본인인증 고유 번호입니다.
- 포트원에서 채번하는 본인인증 시도 고유 번호입니다.

### **`code`** <mark style="color:green;">**string**</mark>

**에러 코드**
**오류 코드**

- 에러가 있는 경우 에러 코드입니다.
- 실패한 경우 오류 코드입니다.

### **`message`** <mark style="color:green;">**string**</mark>

**에러 메시지**

- 에러가 있는 경우 에러 메시지입니다.
- 실패한 경우 오류 메시지입니다.

### **`pgCode`** <mark style="color:green;">**string**</mark>

**PG 에러 코드**
**PG 오류 코드**

- PG에서 에러 코드를 내려 주는 경우 이 에러 코드를 그대로 반환합니다.
- PG에서 오류 코드를 내려 주는 경우 이 오류 코드를 그대로 반환합니다.

### **`pgMessage`** <mark style="color:green;">**string**</mark>

**PG 에러 메시지**
**PG 오류 메시지**

- PG에서 에러 메시지를 내려 주는 경우 이 에러 메시지를 그대로 반환합니다.
- PG에서 오류 메시지를 내려 주는 경우 이 오류 메시지를 그대로 반환합니다.
20 changes: 10 additions & 10 deletions src/routes/(root)/sdk/ko/v2-sdk/payment-response.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,30 +22,30 @@ versionVariants:

### **`txId`** <mark style="color:green;">**string**</mark>

**포트원에서 채번한 결제 트랜잭션 ID**
**결제 시도 고유 번호**

- 포트원에서 채번하는 결제 고유 번호입니다.
- 포트원에서 채번하는 결제 시도 고유 번호입니다.

### **`code`** <mark style="color:green;">**string**</mark>

**에러 코드**
**오류 코드**

- 에러가 있는 경우 에러 코드입니다.
- 실패한 경우 오류 코드입니다.

### **`message`** <mark style="color:green;">**string**</mark>

**에러 메시지**
**오류 메시지**

- 에러가 있는 경우 에러 메시지입니다.
- 실패한 경우 오류 메시지입니다.

### **`pgCode`** <mark style="color:green;">**string**</mark>

**PG 에러 코드**
**PG 오류 코드**

- PG에서 에러 코드를 내려 주는 경우 이 에러 코드를 그대로 반환합니다.
- PG에서 오류 코드를 내려 주는 경우 이 오류 코드를 그대로 반환합니다.

### **`pgMessage`** <mark style="color:green;">**string**</mark>

**PG 에러 메시지**
**PG 오류 메시지**

- PG에서 에러 메시지를 내려 주는 경우 이 에러 메시지를 그대로 반환합니다.
- PG에서 오류 메시지를 내려 주는 경우 이 오류 메시지를 그대로 반환합니다.

0 comments on commit de9bf52

Please sign in to comment.