Payple

https://docs.payple.kr
Admin
Payple is a payment gateway and processing service that provides domestic and international credit...
Tokens:254,801
Snippets:810
Trust Score:6.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET 방식 매출전표 조회 (토큰) - 테스트/라이브 환경

Source: https://docs.payple.kr/operation/international-card/receipt

GET 방식 조회는 결제 승인/취소 응답의 receiptUrl을 그대로 사용하거나 token 파라미터를 직접 전달하여 매출전표를 조회합니다. 별도의 파트너 인증(OAuth)이 필요하지 않습니다. token은 결제 승인/취소 응답값의 receiptUrl에 포함된 암호화 토큰이며, 언어 설정이 필요한 경우 lang 파라미터를 추가할 수 있습니다 (예: &lang=en).

```http
POST
https://demo-api.payple.kr/gpay/receipt?token={token}
테스트 환경
```

```http
POST
https://api.payple.kr/gpay/receipt?token={token}
라이브 환경
```

--------------------------------

### 해외 카드 매출전표 조회

Source: https://docs.payple.kr/operation/international-card/receipt

해외 카드 결제 건에 대한 매출전표(거래 내역서)를 조회하는 API입니다. GET(토큰) 방식과 POST(OAuth) 방식 두 가지를 지원합니다.

```APIDOC
## POST /gpay/receipt?token={token}

### Description
해외 카드 결제 건에 대한 매출전표(거래 내역서)를 조회합니다. GET(토큰) 방식은 별도의 파트너 인증(OAuth) 없이 결제 승인/취소 응답의 receiptUrl에 포함된 token을 사용하여 매출전표를 조회합니다.

### Method
POST

### Endpoint
https://demo-api.payple.kr/gpay/receipt?token={token} (테스트 환경)
https://api.payple.kr/gpay/receipt?token={token} (라이브 환경)

### Parameters
#### Query Parameters
- **token** (string) - Required - 결제 승인/취소 응답값의 receiptUrl에 포함된 암호화 토큰입니다.
- **lang** (string) - Optional - 언어 설정 파라미터입니다. 예: `&lang=en` (영어), 기본값은 한국어(kr)입니다.

### Request Example
POST https://demo-api.payple.kr/gpay/receipt?token=abc123...

### Response
#### Success Response (200)
매출전표 API는 JSON 응답이 아닌 HTML 페이지를 직접 반환합니다. 반환되는 매출전표에는 다음 정보가 포함됩니다.

**상점 정보**
- 상호명 (한국어/영어)
- 서비스명 (한국어/영어)
- 웹사이트
- 전화번호 / 이메일

**결제 정보**
- 거래 ID (pay_id)
- 결제 시간 (KST)
- 주문번호 (service_oid)
- 결제 금액 (통화 포함)
- 환불 금액 (환불 발생 시)
- 상품명
- 국가 (ISO)
- 구매자 이름 / 이메일
- 카드번호 (마스킹)
- 국제 브랜드사

#### Response Example
(HTML 페이지가 직접 반환됩니다.)
```

```APIDOC
## POST /gpay/oauth/1.0/token

### Description
POST 방식으로 매출전표를 조회하기 전에 파트너 인증을 수행하여 Access Token을 발급받습니다. 발급된 토큰은 10분간 유효합니다.

### Method
POST

### Endpoint
https://demo-api.payple.kr/gpay/oauth/1.0/token (테스트 환경)
https://api.payple.kr/gpay/oauth/1.0/token (라이브 환경)

### Parameters
#### Request Body
- **service_id** (string) - Required - 파트너(상점)의 서비스 ID입니다.
- **service_key** (string) - Required - 파트너(상점)의 서비스 키입니다.
- **code** (string) - Required - 파트너 인증에 필요한 토큰을 확인하는 용도로 사용되며, 파트너(상점)가 직접 생성하여 전송해야 하는 중요한 요소입니다. 영문+숫자 조합 10자리로 구성되어야 합니다.

### Request Example
```json
{
  "service_id": "demo",
  "service_key": "abcd1234567890",
  "code": "as12345678"
}
```

### Response
#### Success Response (200)
파트너 인증 후 응답된 access_token을 매출전표 조회 요청 시 Header에 포함하여 사용합니다.

#### Response Example
(응답 예시는 제공되지 않았습니다.)
```

```APIDOC
## POST /gpay/receipt

### Description
파트너 인증(OAuth) 후 발급받은 Access Token을 Header에 포함하여 해외 카드 결제 건에 대한 매출전표(거래 내역서)를 조회합니다.

### Method
POST

### Endpoint
https://demo-api.payple.kr/gpay/receipt (테스트 환경)
https://api.payple.kr/gpay/receipt (라이브 환경)

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - `Bearer ` + {파트너 인증 후 응답된 access_token}
- **Content-Type** (string) - Required - `application/json`
- **Cache-Control** (string) - Required - `no-cache`

#### Request Body
- **pay_id** (string) - Required - 결제 성공 시 응답된 결제 고유 ID입니다.
- **lang** (string) - Optional - 언어 설정 파라미터입니다. `kr`(한국어, 기본값) 또는 `en`(영어)을 지원합니다.

### Request Example
```json
{
  "pay_id": "test_pay_id_123",
  "lang": "kr"
}
```

### Response
#### Success Response (200)
매출전표 API는 JSON 응답이 아닌 HTML 페이지를 직접 반환합니다. 반환되는 매출전표에는 다음 정보가 포함됩니다.

**상점 정보**
- 상호명 (한국어/영어)
- 서비스명 (한국어/영어)
- 웹사이트
- 전화번호 / 이메일

**결제 정보**
- 거래 ID (pay_id)
- 결제 시간 (KST)
- 주문번호 (service_oid)
- 결제 금액 (통화 포함)
- 환불 금액 (환불 발생 시)
- 상품명
- 국가 (ISO)
- 구매자 이름 / 이메일
- 카드번호 (마스킹)
- 국제 브랜드사

#### Response Example
(HTML 페이지가 직접 반환됩니다.)
```

--------------------------------

### Response Example: No Transactions Found

Source: https://docs.payple.kr/operation/reconciliation/domestic-transactions

Example response when no transactions are found within the specified period.

```json
{
  "PCD_PAY_CODE": "PCHK0000",
  "PCD_PAY_MSG": "success",
  "PCD_DATA": {
    "PCD_HAS_MORE": false,
    "PCD_LASTKEY": null,
    "PCD_LIMIT": 1000,
    "PCD_CONTENT": []
  }
}
```

--------------------------------

### 결제창 호출 스크립트 태그 (Demo/Live)

Source: https://docs.payple.kr/integration/domestic-bank/password

Demo 스크립트는 테스트 환경에서, Live 스크립트는 라이브 환경에서 사용합니다. 각각 페이플 결제창을 로드하는 script 태그입니다.

```html
<script src="https://democpay.payple.kr/js/v1/payment.js?v=%datetime%"></script>
```

```html
<script src="https://cpay.payple.kr/js/v1/payment.js?v=%datetime%"></script>
```

--------------------------------

### Response Example: Card Transaction with Partial Cancellation

Source: https://docs.payple.kr/operation/reconciliation/domestic-transactions

Example response for a card payment that underwent partial cancellation within the inquiry period.

```json
{
  "PCD_PAY_CODE": "PCHK0000",
  "PCD_PAY_MSG": "success",
  "PCD_DATA": {
    "PCD_HAS_MORE": false,
    "PCD_LASTKEY": null,
    "PCD_LIMIT": 1000,
    "PCD_CONTENT": [
      {
        "PCD_CST_ID": "PAYLAP01",
        "PCD_PAY_OID": "order12345",
        "PCD_PAY_TIME": "2026-05-01 13:00:00", // 원결제 승인일시
        "PCD_PAY_TYPE": "card",
        "PCD_PAYER_NO": "1234",
        "PCD_PAYER_ID": "OVA3...",
        "PCD_PAY_GOODS": "테스트 상품",
        "PCD_PAY_AMOUNT": 50000,
        "PCD_PAY_TOTAL": 40000,
        "PCD_PAY_ISTAX": "Y",
        "PCD_PAY_TAXTOTAL": 3636,
        "PCD_REGULER_FLAG": "N",
        "PCD_PAY_STATE": "부분승인취소완료",
        "PCD_PAYER_NAME": "홍길동",
        "PCD_PAY_CARDQUOTA": "00",
        "PCD_PAY_CARDNAME": "국민",
        "PCD_PAY_CARDNUM": "1234-****-****-5678",
        "PCD_PAY_CARDTRADENUM": "paypletttm0101260501130000a123",
        "PCD_PAY_CARDAUTHNO": "12345678",
        "PCD_PAY_PAYMENT_TYPE": "신용카드",
        "PCD_TRANSACTIONS": [ // 조회 기간 내 발생 거래
          {
            "PCD_TX_TYPE": "APPROVAL",
            "PCD_TX_TIME": "2026-05-01 13:00:00",
            "PCD_TX_AMOUNT": 50000,
            "PCD_TX_TAX_AMOUNT": 4545
          },
          {
            "PCD_TX_TYPE": "CANCEL",
            "PCD_TX_TIME": "2026-05-01 18:30:00",
            "PCD_TX_AMOUNT": -10000,
            "PCD_TX_TAX_AMOUNT": -909
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### POST /php/SimplePayAct.php?ACT_=PAYM

Source: https://docs.payple.kr/parameters/domestic-card/easy-billing

빌링키로 재결제는 실결제 승인 과정에서 필요한 API입니다. 파트너 인증 후 수신한 인증 키와 빌링키를 이용하여 정기(빌링) 결제를 승인합니다.

```APIDOC
## POST /php/SimplePayAct.php?ACT_=PAYM

### Description
빌링키로 재결제는 실결제 승인 과정에서 필요한 API입니다. 파트너 인증 후 수신한 인증 키와 빌링키를 이용하여 정기(빌링) 결제를 승인합니다.

### Method
POST

### Endpoint
/php/SimplePayAct.php?ACT_=PAYM

### Parameters
#### Request Body
- **PCD_CST_ID** (String) - Required - 파트너 인증을 위한 ID입니다. (예: UFVNNVZ…)
- **PCD_CUST_KEY** (String) - Required - 파트너 인증 후 수신한 키입니다. (예: T3JzRkp5L…)
- **PCD_AUTH_KEY** (String) - Required - 인증완료 후 수신하는 파트너 인증 키입니다. 파트너 인증 응답으로 받은 값을 그대로 사용해주세요. (예: K0VnW…)
- **PCD_PAY_TYPE** (String) - Required - 카드 결제수단 중 앱카드, 정기(빌링), 비밀번호 간편결제 방식을 선택합니다. 카드: card / 계좌: transfer (예: card)
- **PCD_PAYER_ID** (String) - Required - 간편페이 정기(빌링) 결제 시 필요한 빌링키입니다. PCD_PAY_METHOD를 전송하는 경우 동일한 간편페이 수단으로 발급된 값을 전송해주세요. (예: OVA3…)
- **PCD_PAY_GOODS** (String) - Required - 상품명입니다. Emoji 또는 허용되지 않은 특수문자(& ' " \ < > | \n \r\n , +)만으로 구성된 값은 입력할 수 없습니다. (예: 테스트 상품)
- **PCD_SIMPLE_FLAG** (String) - Required - 정기(빌링) 결제 시 필요한 설정값입니다. (예: Y)
- **PCD_PAY_TOTAL** (Number) - Required - 총 결제금액입니다. (예: 1000)
- **PCD_PAY_METHOD** (String) - Optional - 사용할 간편페이 수단을 명시하려는 경우 선택적으로 전송합니다. 미전송 시 PCD_PAYER_ID에 연결된 간편페이 수단으로 처리됩니다. 네이버페이: naverPay, 카카오페이: kakaoPay. 전송하는 경우 PCD_PAYER_ID 발급 시 선택한 간편페이 수단과 동일하게 설정해주세요. (예: naverPay kakaoPay)
- **PCD_PAY_OID** (String) - Optional - 승인 요청 건의 주문번호로 파트너(상점)에서 생성한 거래의 고유 식별번호입니다. 중복되지 않는 고유한 값을 발급해야 하며, 미전송 시 페이플에서 발급한 주문번호를 응답합니다. 한글은 사용할 수 없으며 영문, 숫자, 특수문자(-, _, .)만 사용 가능합니다. (예: order12345)
- **PCD_PAYER_NO** (Number) - Optional - 파트너(상점)에서 이용하는 회원번호입니다. (예: 1234)
- **PCD_PAYER_NAME** (String) - Optional - 구매자 이름입니다. Emoji 또는 허용되지 않은 특수문자(& ' " \ < > | \n \r\n , +)만으로 구성된 값은 입력할 수 없습니다. (예: 김이플)
- **PCD_PAYER_HP** (String) - Optional - 구매자 휴대폰번호입니다. 구매자에게 결제된 상점정보를 알림톡으로 발송합니다. (예: 01012345678)
- **PCD_PAYER_EMAIL** (String) - Optional - 구매자 이메일입니다. 결제완료, 취소 메일이 발송됩니다. (예: complete@payer-email.com)
- **PCD_PAY_ISTAX** (String) - Optional - 과세 여부입니다. 기본값은 Y이며, 유형별로 아래와 같이 설정해주세요. 과세, 복합과세: Y / 비과세: N (예: Y)
- **PCD_PAY_TAXTOTAL** (Number) - Optional - 복합과세 주문 시에만 이용하며, 복합과세 주문의 부가세를 설정합니다. 예: 총 결제금액(PCD_PAY_TOTAL) 10,000원 중 복합과세 주문의 부가세가 500원이면 500으로 설정 (예: 500)
- **PCD_USER_DEFINE1** (String) - Optional - 파트너(상점)에서 입력한 값을 그대로 응답합니다. (예: define1)
- **PCD_USER_DEFINE2** (String) - Optional - 파트너(상점)에서 입력한 값을 그대로 응답합니다. (예: define2)

### Response
#### Success Response (200)
- **PCD_PAY_RST** (String) - 승인 결과입니다. success : 성공 / error : 실패 (예: success)
- **PCD_PAY_CODE** (String) - 응답 코드입니다. (예: SPCD0000)
- **PCD_PAY_MSG** (String) - 응답 메시지입니다. (예: 카드결제완료)
- **PCD_PAY_OID** (String) - 주문번호입니다. 파트너(상점)에서 미전송 시 페이플에서 발급한 주문번호를 응답합니다. (예: order12345)
- **PCD_PAY_TYPE** (String) - 결제수단(카드/계좌)입니다. (예: card)
- **PCD_PAYER_ID** (String) - 간편페이 정기(빌링) 결제 시 필요한 빌링키입니다. (예: ova3...)
- **PCD_PAYER_NO** (String) - 파트너(상점)에서 이용하는 회원번호입니다. (예: 1234)
- **PCD_PAYER_NAME** (String) - 구매자 이름입니다. (예: 김이플)
- **PCD_PAYER_HP** (String) - 구매자 휴대폰번호입니다. (예: 01012345678)
- **PCD_PAYER_EMAIL** (String) - 구매자 이메일입니다. (예: complete@payer-email.com)
- **PCD_PAY_GOODS** (String) - 상품명입니다. (예: 테스트 상품)
- **PCD_PAY_TOTAL** (String) - 총 결제금액입니다. (예: 1000)
- **PCD_PAY_TAXTOTAL** (String) - 복합과세 부가세입니다. (예: 500)
- **PCD_PAY_ISTAX** (String) - 과세 여부입니다. (예: Y)
- **PCD_PAY_TIME** (String) - 결제를 요청한 시간입니다. (예: 20231219134223)
- **PCD_PAY_CARDNAME** (String) - 카드사명입니다. (예: 삼성카드)
- **PCD_PAY_CARDNUM** (String) - 카드번호입니다. (예: 1234-****-** **-5678)
- **PCD_PAY_CARDTRADENUM** (String) - 해당 거래의 고유한 키입니다. (예: 202312191342223302115099)
- **PCD_PAY_CARDAUTHNO** (String) - 승인번호입니다. (예: 85324231)
- **PCD_PAY_CARDRECEIPT** (String) - 매출 전표(영수증) 출력 URL입니다. (예: https://www.danalpay.com/...)
- **PCD_SIMPLE_FLAG** (String) - 정기(빌링) 결제 시 필요한 설정값입니다. (예: Y)
- **PCD_USER_DEFINE1** (String) - 파트너(상점)에서 입력한 값을 그대로 응답합니다. (예: define1)
- **PCD_USER_DEFINE2** (String) - 파트너(상점)에서 입력한 값을 그대로 응답합니다. (예: define2)

#### Response Example
{
  "PCD_PAY_RST": "success",
  "PCD_PAY_CODE": "SPCD0000",
  "PCD_PAY_MSG": "카드결제완료",
  "PCD_PAY_OID": "order12345",
  "PCD_PAY_TYPE": "card",
  "PCD_PAYER_ID": "ova3...",
  "PCD_PAYER_NO": "1234",
  "PCD_PAYER_NAME": "김이플",
  "PCD_PAYER_HP": "01012345678",
  "PCD_PAYER_EMAIL": "complete@payer-email.com",
  "PCD_PAY_GOODS": "테스트 상품",
  "PCD_PAY_TOTAL": "1000",
  "PCD_PAY_TAXTOTAL": "500",
  "PCD_PAY_ISTAX": "Y",
  "PCD_PAY_TIME": "20231219134223",
  "PCD_PAY_CARDNAME": "삼성카드",
  "PCD_PAY_CARDNUM": "1234-****-** **-5678",
  "PCD_PAY_CARDTRADENUM": "202312191342223302115099",
  "PCD_PAY_CARDAUTHNO": "85324231",
  "PCD_PAY_CARDRECEIPT": "https://www.danalpay.com/...",
  "PCD_SIMPLE_FLAG": "Y",
  "PCD_USER_DEFINE1": "define1",
  "PCD_USER_DEFINE2": "define2"
}
```

--------------------------------

### POST /php/SimplePayAct.php?ACT_=PAYM

Source: https://docs.payple.kr/parameters/domestic-card/easy-billing

파트너 인증 요청은 빌링키 승인 요청 시 요구되는 파트너 인증을 수행하는 API입니다. 인증에 필요한 파라미터를 전송하여 파트너 인증 서버로부터 인증 결과와 함께 이후 결제 요청에 필요한 인증 키를 응답받습니다.

```APIDOC
## POST /php/SimplePayAct.php?ACT_=PAYM

### Description
파트너 인증 요청은 빌링키 승인 요청 시 요구되는 파트너 인증을 수행하는 API입니다. 인증에 필요한 파라미터를 전송하여 파트너 인증 서버로부터 인증 결과와 함께 이후 결제 요청에 필요한 인증 키를 응답받습니다.

### Method
POST

### Endpoint
/php/SimplePayAct.php?ACT_=PAYM

### Parameters
#### Request Body
- **cst_id** (String) - Required - 파트너 인증을 위한 ID입니다. 라이브 ID는 계약이 완료되어야 발급 가능합니다. (예: test)
- **custKey** (String) - Required - 파트너 인증을 위한 키입니다. 라이브 키는 계약이 완료되어야 발급 가능합니다. 외부에 노출되면 안 되는 정보입니다. (예: abcd1234567890)
- **PCD_PAY_TYPE** (String) - Required - 결제수단(카드/계좌)입니다. 카드: card / 계좌: transfer (예: card)
- **PCD_SIMPLE_FLAG** (String) - Required - 정기(빌링), 비밀번호 간편결제 시 필요한 설정값입니다. (예: Y)

### Response
#### Success Response (200)
- **server_name** (String) - 파트너 인증 서버의 Domain을 반환합니다. (예: democpay.payple.kr)
- **result** (String) - 인증 결과입니다. (예: success)
- **result_msg** (String) - 결과 메시지입니다. (예: 사용자 인증 완료!!)
- **cst_id** (String) - 파트너 ID입니다. 매 인증 시 변동되는 값입니다. (예: UFVNNVZ…)
- **custKey** (String) - 파트너 인증 키입니다. 매 인증 시 변동되는 값입니다. (예: T3JzRkp5L…)
- **AuthKey** (String) - 파트너 인증 키입니다. 매 인증 시 변동되는 값입니다. (예: a688ccb3555...)
- **PCD_PAY_HOST** (String) - 페이플 접속 주소입니다. (예: https://democpay.payple.kr)
- **PCD_PAY_URL** (String) - 파트너 인증 결과로 응답되는 URL Path입니다. (예: /php/SimplePayAct.php?ACT_=PAYM)
- **return_url** (String) - 파트너 인증 결과로 응답되는 URL입니다. (예: https://democpay.payple.kr/php/SimplePayAct.php?ACT_=PAYM)

#### Response Example
{
  "server_name": "democpay.payple.kr",
  "result": "success",
  "result_msg": "사용자 인증 완료!!",
  "cst_id": "UFVNNVZ…",
  "custKey": "T3JzRkp5L…",
  "AuthKey": "a688ccb3555...",
  "PCD_PAY_HOST": "https://democpay.payple.kr",
  "PCD_PAY_URL": "/php/SimplePayAct.php?ACT_=PAYM",
  "return_url": "https://democpay.payple.kr/php/SimplePayAct.php?ACT_=PAYM"
}
```

--------------------------------

### Response Example: Transfer Transaction with Refund

Source: https://docs.payple.kr/operation/reconciliation/domestic-transactions

Example response for a transfer payment where a refund occurred within the inquiry period, even if the original payment date was outside the period.

```json
{
  "PCD_PAY_CODE": "PCHK0000",
  "PCD_PAY_MSG": "success",
  "PCD_DATA": {
    "PCD_HAS_MORE": false,
    "PCD_LASTKEY": null,
    "PCD_LIMIT": 1000,
    "PCD_CONTENT": [
      {
        "PCD_CST_ID": "PAYLAP01",
        "PCD_PAY_OID": "order67890",
        "PCD_PAY_TIME": "2026-04-25 09:30:00", // 원결제 승인일시 (조회 기간 밖)
        "PCD_PAY_TYPE": "transfer",
        "PCD_PAYER_NO": "5678",
        "PCD_PAYER_ID": "OVA4...",
        "PCD_PAY_GOODS": "구독 상품",
        "PCD_PAY_AMOUNT": 30000,
        "PCD_PAY_TOTAL": 10000,
        "PCD_PAY_ISTAX": "Y",
        "PCD_PAY_TAXTOTAL": 909,
        "PCD_REGULER_FLAG": "N",
        "PCD_PAY_STATE": "부분승인취소완료",
        "PCD_PAYER_NAME": "김철수",
        "PCD_PAY_BANK": "020",
        "PCD_PAY_BANKNAME": "우리은행",
        "PCD_PAY_BANKNUM": "123-********-456",
        "PCD_TAXSAVE_FLAG": "Y",
        "PCD_TAXSAVE_RST": "Y",
        "PCD_TAXSAVE_MGTNUM": "G123456",
        "PCD_TRANSACTIONS": [ // 조회 기간 내 발생 거래
          {
            "PCD_TX_TYPE": "CANCEL",
            "PCD_TX_TIME": "2026-05-01 10:20:30",
            "PCD_TX_AMOUNT": -10000,
            "PCD_TX_TAX_AMOUNT": -909
          },
          {
            "PCD_TX_TYPE": "CANCEL",
            "PCD_TX_TIME": "2026-05-01 18:45:00",
            "PCD_TX_AMOUNT": -10000,
            "PCD_TX_TAX_AMOUNT": -909
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Server Authentication Result Reception

Source: https://docs.payple.kr/integration/domestic-bank/password

Example of receiving authentication result on the server side using a POST request handler.

```APIDOC
## Server Authentication Result Reception

### Description
Receives the authentication result via POST to the PCD_RST_URL. The result is sent as form data.

### Method
POST

### Endpoint
PCD_RST_URL (configured by merchant)

### Parameters
#### Form Data
- **PCD_PAY_RST** (string) - Required - Result of authentication: 'success' or 'fail'
- **PCD_PAY_CODE** (string) - Required - Result code

### Request Example
```javascript
export async function POST(request) {
  const formData = await request.formData()

  const PCD_PAY_RST = formData.get('PCD_PAY_RST')
  const PCD_PAY_CODE = formData.get('PCD_PAY_CODE')
  // ...

  if (PCD_PAY_RST === 'success') {
    // 인증 성공 → 결제 승인 요청 진행
  } else {
    // 인증 실패 처리
  }

  return Response.json({ isOk: true })
}
```

### Response
#### Success Response (200)
- **isOk** (boolean) - Indicates successful receipt of the result.
```

--------------------------------

### 결제창 연동 스크립트 태그 (테스트/라이브)

Source: https://docs.payple.kr/integration/international-card/key-in

결제창 연동을 위해 서버 환경에 따라 테스트 또는 라이브 스크립트를 페이지에 포함합니다. 테스트 환경은 demo-gpay.payple.kr, 라이브 환경은 gpay.payple.kr 도메인을 사용합니다.

```html
<!-- 테스트 -->
<script src="https://demo-gpay.payple.kr/common/js/gpay-1.0.1.js"></script>
```

```html
<!-- 라이브 -->
<script src="https://gpay.payple.kr/common/js/gpay-1.0.1.js"></script>
```

--------------------------------

### Client Authentication Result Reception (callbackFunction)

Source: https://docs.payple.kr/integration/domestic-bank/password

Example of receiving authentication result on the client side using callbackFunction for SPA applications.

```APIDOC
## Client Authentication Result Reception (callbackFunction)

### Description
Receives the authentication result on the client side using a callback function. This is only available when PCD_RST_URL is set to a relative path.

### Method
Callback

### Parameters
#### Callback Parameters
- **params.PCD_PAY_RESULT** (string) - Required - Result of authentication: 'success' or 'fail'

### Request Example
```javascript
// 클라이언트에서 인증 결과를 수신할 경우에만 callbackFunction을 사용해주세요.
// getResult는 파트너(상점)가 구현한 함수입니다.
obj.callbackFunction = getResult;

// getResult 함수 구현 예시
function getResult(params) {
    if (params.PCD_PAY_RESULT === 'success'){
        // server side로 결제 승인요청 구현
    } else {
        // 결제 실패 페이지 렌더링
    }
}
```
```

--------------------------------

### POST /php/auth.php

Source: https://docs.payple.kr/operation/reconciliation/domestic-transactions

거래내역 조회를 위한 파트너 인증 요청입니다. 페이플에 등록된 도메인을 Referer 헤더에 정확히 입력해야 하며, 인증 후 30분 동안 유효합니다.

```APIDOC
## POST /php/auth.php

### Description
파트너 인증을 통해 거래내역 조회 API 사용을 위한 토큰을 발급받습니다. 인증 후 30분 동안 유효하며, 이후 거래내역 조회 요청 시 사용됩니다.

### Method
POST

### Endpoint
- 테스트 환경: https://democpay.payple.kr/php/auth.php
- 라이브 환경: https://cpay.payple.kr/php/auth.php

### Parameters
#### Header
- **Content-Type** (string) - Required - application/json
- **Cache-Control** (string) - Required - no-cache
- **Referer** (string) - Required - 페이플에 등록된 파트너(상점)의 도메인 (예: https://your-domain.com)

#### Request Body
- **cst_id** (string) - Required - 파트너 ID
- **custKey** (string) - Required - 파트너 키
- **PCD_PAYCHK_LIST_FLAG** (string) - Required - 거래내역 조회 인증/요청 플래그, 값은 "Y"

### Request Example
{
  "cst_id": "test",
  "custKey": "abcd1234567890",
  "PCD_PAYCHK_LIST_FLAG": "Y"
}

### Response
#### Success Response (200)
- 인증 성공 시 토큰이 반환됩니다. (구체적인 응답 필드는 문서에 명시되지 않음)

#### Response Example
(문서에 명시되지 않음)

### Error Handling
- Referer 도메인이 일치하지 않을 경우 'AUTH0004' 오류 메시지가 반환됩니다.
```

--------------------------------

### AndroidManifest.xml: Register package queries for card apps

Source: https://docs.payple.kr/webview

Add these <queries> entries to AndroidManifest.xml to allow the app to detect installed card and security apps. Required for app card payment integration.

```XML
<queries>
<!-- 보안 -->
<package android:name="com.ahnlab.v3mobileplus"/>
<package android:name="com.TouchEn.mVaccine.webs"/>

<!-- 우리카드 -->
<package android:name="com.wooricard.wpay"/>
<package android:name="com.wooricard.smartapp"/>
<package android:name="com.wooribank.smart.npib"/>
<package android:name="com.mysmilepay.app"/>

<!-- 씨티카드 -->
<package android:name="kr.co.citibank.citimobile"/>
<package android:name="com.citibank.cardapp"/>

<!-- 신한카드 -->
<package android:name="com.shcard.smartpay"/>
<package android:name="com.shinhancard.smartshinhan"/>
<package android:name="com.shinhan.smartcaremgr"/>
<package android:name="com.mobiletoong.travelwallet"/>

<!-- ISP/페이북 -->
<package android:name="kvp.jjy.MispAndroid320"/>

<!-- KB카드 -->
<package android:name="com.kbcard.cxh.appcard"/>
<package android:name="com.kbstar.reboot"/>
<package android:name="com.kbstar.kbbank"/>
<package android:name="com.kbstar.liivbank"/>

<!-- 현대카드 -->
<package android:name="com.hyundaicard.appcard"/>
<package android:name="com.samsung.android.spaylite"/>
<package android:name="com.ssg.serviceapp.android.egiftcertificate"/>

<!-- 삼성카드 -->
<package android:name="kr.co.samsungcard.mpocket"/>
<package android:name="com.nhnent.payapp"/>
<package android:name="com.samsung.android.spaylite"/>
<package android:name="net.ib.android.smcard"/>

<!-- 하나카드 -->
<package android:name="com.hanaskcard.paycla"/>
<package android:name="kr.co.hanamembers.hmscustomer"/>
<package android:name="com.samsung.android.spaylite"/>
<package android:name="com.kakao.talk"/>
<package android:name="com.hanaskcard.rocomo.potal"/>
<package android:name="com.ahnlab.v3mobileplus"/>
<package android:name="com.lge.lgpay"/>
<package android:name="viva.republica.toss"/>
<package android:name="com.samsung.android.spay"/>
<package android:name="com.nhnent.payapp"/>

<!-- 롯데카드 -->
<package android:name="com.lcacApp"/>
<package android:name="com.lotte.lpay"/>
<package android:name="com.nhnent.payapp"/>
<package android:name="com.lottemembers.android"/>
<package android:name="com.samsung.android.spaylite"/>

<!-- 농협카드 -->
<package android:name="nh.smart.nhallonepay"/>
</queries>
```
Tokens:
Raw