> ## Documentation Index
> Fetch the complete documentation index at: https://doc.haipay.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 韩国

<Warning>
  **阅读该接口文档前，务必先查看 [**接口说明**](/docs/zh/guide/api_description_guide)**
</Warning>

## **限额**

| 交易类型 | 限额                              |
| :--- | ------------------------------- |
| 代收   | 美元: 0.99-1000, 韩元: 1000-1500000 |
| 代付   | 韩元: 1000-1500000                |

> **金额小数位：** KRW — 0位小数（仅整数） | USD — 2位小数

## **代收API**

### **代收申请**

**简要描述：**

* 创建代收订单

**URL：**

韩元: `/krw/collect/apply`
说明：appId需使用韩元对应的，用户支付成功后增加韩元余额

美元: `/usd/collect/apply`
说明：appId需使用美元对应的，用户支付成功后增加美元余额

**参数：**

| 参数名             | 必选 | 类型     | 说明                                                                                         |
| :-------------- | :- | :----- | :----------------------------------------------------------------------------------------- |
| appId           | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID）                                                            |
| orderId         | 是  | String | 商户订单号(必须保证唯一性，长度不超过48)                                                                     |
| name            | 是  | String | 用户姓名，推荐使用真实姓名，格式：包含firstName和lastName，以空格分割的，示例：John Doe                                   |
| phone           | 是  | String | 真实手机号（格式参考 [电话号码格式](/docs/zh/guide/frequently_asked_question#zh_faq_phone-number-format) ） |
| email           | 是  | String | 真实电子邮件                                                                                     |
| amount          | 是  | String | 交易金额（精确到小数点后两位；禁止添加标点符号，例如：”,”） 范围参考：收款编码Code                                              |
| payType         | 是  | String | [交易类型](#inBankCode)                                                                        |
| inBankCode      | 是  | String | [支付方式](#inBankCode)                                                                        |
| callBackUrl     | 是  | String | 用户支付成功后跳转地址                                                                                |
| callBackFailUrl | 是  | String | 用户支付失败后跳转地址                                                                                |
| notifyUrl       | 否  | String | 回调地址                                                                                       |
| subject         | 否  | String | 支付备注                                                                                       |
| country         | 否  | String | 收银台模式需要传递，请传：410                                                                           |
| body            | 否  | String | 备注详情                                                                                       |
| partnerUserId   | 是  | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。            |
| sign            | 是  | String | 签名                                                                                         |

返回data参数说明

| 参数名     | 类型     | 说明             |
| :------ | :----- | :------------- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号          |
| payUrl  | String | 支付链接           |
| sign    | String | 签名             |

### **代收查询**

**简要描述：**

* 查询代收订单

**URL：**

韩元: `/krw/collect/query`

美元: `/usd/collect/query`

**参数：**

| 参数名     | 必选 | 类型     | 说明                              |
| :------ | :- | :----- | :------------------------------ |
| appId   | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是  | String | 商户订单号                           |
| orderNo | 否  | String | 平台订单号（响应快）                      |
| sign    | 是  | String | 签名                              |

request

```json theme={null}
{
  "appId": 1054,
  "orderId": "M22222000028",
  "sign": "EmyJGm3ELzG4FsOd0Krs9ncbSjo4oTGuXWML+7djYla3+VAwd9wS17z38p/7U2ZAjroO04XrE7YXcB1o76Dtyipj3h3bJzs7FYma1QNkMUdt9hh7m8U6hMsMQX7vIWHtXNwz4pbTSC75+kQWXaCew7KoE6LXECdJU8AISgNgeki2TK9R0pCfshr0Z2SZBPeuT6OvIH5LdmqgdZhuqnffGU2qnXk4KMkO848e6/WALLBR+LE1wyKHfPnYVcuKSMVYxkvKyyIL5JIPEgW0o5bh4RCbaUn3NZtyYwrU1uQ3ZDFRThm9j6XAQP+LBlmq3nOePqBtp/VDVarRaV+7FbQg3A=="
}
```

response

```json theme={null}
{
  "status": "1",
  "error": "00000000",
  "msg": "",
  "data": {
    "orderId": "M22222000028",
    "orderNo": "6023042811314347",
    "amount": "50.00",
    "actualAmount": "0.00",
    "fee": "0.00",
    "status": 1,
    "sign": "fP433ygWVDLVGxYkVnIJj7riGq0U3vyVX+MbBAImxfGLZkZcEAHVEoVYuULZSmXAAXKRSyd67WlDNm+24pougM54ofAoH4HMtCL2tfCoBReFyz3z02AGKkrKE2xWhSpWoqfQoBvzwuN5iGMMu0s9Q1YvqiwJ8WDVIENnmiIyD8qDJN7caHTW2US14/faG+69AvnuIgJ/nu7/jogOlgEYdZdVYU7gcRDE+d47KjlFGswQkJ/h/uzV7cWtUqrtOO7ZnZ3/z33Xx8awokX36QoYcPSWAU0h+Ij9O9402HNhm1eTbYcLU0uI/z8xCAtyAI/tTyiFijpiNlxUKQj+zKsILw=="
  }
}
```

返回data参数说明

| 参数名          | 类型      | 说明                                                  |
| :----------- | :------ | :-------------------------------------------------- |
| orderId      | String  | 商户订单号(必须保证唯一性)                                      |
| orderNo      | String  | 平台订单号                                               |
| amount       | String  | 交易金额                                                |
| actualAmount | String  | 收到金额                                                |
| fee          | String  | 手续费                                                 |
| status       | Integer | 状态(0未开始，1支付中，2成功（终态），3失败（终态）, -1异常待确认)              |
| payTime      | String  | 支付成功时间（当status=2时有值）(本地时间), 格式: yyyy-MM-dd HH:mm:ss |
| errorMsg     | String  | 支付失败原因（当status=3时有值）                                |
| sign         | String  | 签名                                                  |

### **支付方式** <a id="inBankCode" />

| 币种  | 支付类型(payType)        | 支付编码(inBankCode) | 限额           | 状态 | 说明                                                     |
| --- | -------------------- | ---------------- | ------------ | -- | ------------------------------------------------------ |
| KRW | EWALLET              | KAKAOPAY\_KRW    | 1000-1500000 | 可用 | Kakao Pay钱包                                            |
| KRW | EWALLET              | NAVERPAY\_KRW    | 1000-1500000 | 可用 | Naver Pay钱包                                            |
| KRW | EWALLET              | TOSS\_KRW        | 1000-1500000 | 可用 | Toss Pay钱包                                             |
| KRW | EWALLET              | SAMSUNGPAY\_KRW  | 1000-1500000 | 可用 | Samsung Pay钱包                                          |
| KRW | EWALLET              | PAYCO\_KRW       | 1000-1500000 | 可用 | PayCo钱包                                                |
| KRW | BANK\_TRANSFER       | BANK\_KRW        | 1000-1500000 | 可用 | 银行账号授权支付(支持韩国所有银行)                                     |
| KRW | VA (Virtual Account) | VA\_BANK\_KRW    | 300-500000   | 可用 | VA收银台入口                                                |
| KRW | VA (Virtual Account) | KOOKMIN\_BANK    | 300-500000   | 可用 | 支持银行：Kookmin Bank                                      |
| KRW | VA (Virtual Account) | SHBKKRSE         | 300-500000   | 可用 | 支持银行：Shinhan Bank                                      |
| KRW | VA (Virtual Account) | HANA\_BANK       | 300-500000   | 可用 | 支持银行：Hana Bank                                         |
| KRW | VA (Virtual Account) | WOORI\_BANK      | 300-500000   | 可用 | 支持银行：Woori Bank                                        |
| KRW | VA (Virtual Account) | NONGHYUP\_BANK   | 300-500000   | 可用 | 支持银行：Nonghyup Bank                                     |
| KRW | VA (Virtual Account) | IBK              | 300-500000   | 可用 | 支持银行：IBK                                               |
| KRW | VA (Virtual Account) | SC\_BANK         | 300-500000   | 可用 | 支持银行：SC Bank                                           |
| KRW | VA (Virtual Account) | KBANK            | 300-500000   | 可用 | 支持银行：Kbank                                             |
| KRW | VA (Virtual Account) | SUHYUP           | 300-500000   | 可用 | 支持银行：Suhyup                                            |
| KRW | VA (Virtual Account) | DAEGU\_BANK      | 300-500000   | 可用 | 支持银行：Daegu Bank                                        |
| KRW | VA (Virtual Account) | BUSAN\_BANK      | 300-500000   | 可用 | 支持银行：Busan Bank                                        |
| KRW | VA (Virtual Account) | KYONGNAM\_BANK   | 300-500000   | 可用 | 支持银行：Kyongnam Bank                                     |
| KRW | VA (Virtual Account) | KWANGJU\_BANK    | 300-500000   | 可用 | 支持银行：Kwangju Bank                                      |
| KRW | VA (Virtual Account) | KFCC             | 300-500000   | 可用 | 支持银行：Korea Federation of Community Credit Cooperatives |
| KRW | VA (Virtual Account) | KOREA\_POST      | 300-500000   | 可用 | 支持银行：Korea Post                                        |
| USD | EWALLET              | KAKAOPAY\_USD    | 0.99-1000    | 可用 | Kakao Pay钱包                                            |
| USD | EWALLET              | NAVERPAY\_USD    | 0.99-1000    | 可用 | Naver Pay钱包                                            |
| USD | EWALLET              | TOSS\_USD        | 0.99-1000    | 可用 | Toss Pay钱包                                             |
| USD | EWALLET              | SAMSUNGPAY\_USD  | 0.99-1000    | 可用 | Samsung Pay钱包                                          |
| USD | EWALLET              | PAYCO\_USD       | 0.99-1000    | 可用 | PayCo钱包                                                |
| USD | BANK\_TRANSFER       | KR\_BANK\_USD    | 0.99-1000    | 可用 | 银行账号授权支付(支持韩国所有银行)                                     |

## **代付API**

### **代付申请**

**简要描述：**

* 创建代付订单

**URL：`/krw/pay/apply`**

**参数：**

| 参数名           | 必选 | 类型     | 说明                                                                                             |
| :------------ | :- | :----- | :--------------------------------------------------------------------------------------------- |
| appId         | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID）                                                                |
| orderId       | 是  | String | 商户订单号(必须保证唯一性，长度不超过48)                                                                         |
| amount        | 是  | String | 交易金额（单位：₩，精确到小数点后两位；禁止添加标点符号，例如：”,”）                                                           |
| accountType   | 是  | String | 账户类型：BANK\_ACCOUNT(银行账号)                                                                       |
| bankCode      | 是  | String | 银行编码(见附录代付银行编码)                                                                                |
| accountNo     | 是  | String | 用户银行账号                                                                                         |
| name          | 是  | String | 收款人姓名(收款人姓名 格式：英文大小写且允许有空格，1-30位,"firstName middleName lastName" (middleName 非必填, 特殊字符支持 '.-)) |
| phone         | 是  | String | 手机号                                                                                            |
| email         | 是  | String | 电子邮件                                                                                           |
| notifyUrl     | 否  | String | 回调地址                                                                                           |
| subject       | 否  | String | 支付备注                                                                                           |
| body          | 否  | String | 备注详情                                                                                           |
| partnerUserId | 是  | String | 用户唯一标识（如用户ID userId），用于风控系统，必须真实有效，否则会影响交易。 格式要求：数字、大小写字母或常用符号-\~!@#\$%&\*()\_。                |
| sign          | 是  | String | 签名                                                                                             |

#####

request（accountType为BANK\_ACCOUNT类型时）

```json theme={null}
{
"appId": 1054,
    "orderId": "M100000450012",
    "amount": "2000",
    "accountType": "BANK_ACCOUNT",
    "bankCode": "KYNAKR22",
    "accountNo": "09876543210",
    "name": "john doe",
    "phone": "09876543210",
    "email": "johndoe@cashfree.com",
    "subject": "iphone13",
    "body": "ProMotion technology with adaptive refresh rates up to 120Hz",
    "partnerUserId": "149597870",
    "sign": "I1PeK3eJOVsFFNowxVRqMXpeWm1lr/BcRpBi8WsW4wVo1+5CC3JsrFq/m/L2O69NzKHvtDWi4zia3DL3dPut0yMyUyqL91LNCSaeISbGsQPlhEsQpyTOryS/RKOfsrn2Xo37SCF/phAvndOk2jwwGwqM5xLz1ms9Ukl85wv27QFNrXIMxK2p18oe7MpMYrgf+xvEBE/VqCtKMtN9pO449wWwXzHWNPbZ76s4pAvKwRE9yXQDr7Iw14Dktcnl1FoLM4gWM/obkO+mz6SyAGDuXhVh/+OD/IGNiCyTCNq6ciQY28UnCFV6ZIP40gxsFhfBJKbK+Raw7y1Bh912ifYfug=="
}
```

response

```json theme={null}
{
"status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M100000450013",
        "orderNo": "3023062014149637",
        "sign": "LmhUnkw5j0pMiimsG8rKwdNNZGvXH5MpSmD6mdHZwq1SQwuK5BohmdEoqKB/jkMk28o3da4Cxh6Q+tW97+yTCemRrF+dMaHA73rpOeUuujKQl/UcFvJuMhfLBa2tp09L71NzoBqpPD6aXf37mYAz8E1HmERwFPpac5FVxIYanHG8cqmMLJYsVmHTSxWavgWU03ys9UczBePkBiR8sl2FSOhFABB0wAP28lswrV/ABS68IsLKtyd1fyI3GBfSbIK5nDEEnlE+EdElFdLs9taAxJImeVF1x4eT47+bkPJ2qS8z3K8QGzKLF3W+8SiRZGfSwDTsLKH+2Vycvy5auRl+ag=="
}
}
```

返回data参数说明

| 参数名     | 必选     | 类型             |
| :------ | :----- | :------------- |
| orderId | String | 商户订单号(必须保证唯一性) |
| orderNo | String | 平台订单号          |
| sign    | String | 签名             |

### **代付查询**

**简要描述：**

* 创建代付订单

**URL：`/krw/pay/query`**

**参数：**

| 参数名     | 必选 | 类型     | 说明                              |
| :------ | :- | :----- | :------------------------------ |
| appId   | 是  | Long   | 业务ID（后台获取，需要根据URL中的币种传递对应的业务ID） |
| orderId | 是  | String | 商户订单号                           |
| orderNo | 否  | String | 平台订单号（响应快）                      |
| sign    | 是  | String | 签名                              |

request

```json theme={null}
{
"appId": 1000,
    "orderId": "M1234567111",
    "orderNo": "3022111516571436",
    "sign": "ZxkVZL+GAyv0VhvWn4IvuYahTzxgQuthkuV2ONWiqIfIDb2avvHlFOUJVzqZi1q8CPHXZm1ltanRTRVTxfsuftLvGeDioUHglWt46/RU6c1OPznpLGsZ35Q3n5tW2y1EnOsxPynXBFLuDQy+aZ3l9u6AQ30T0zQexMGT+IxuFkmUp02g/6juaHa5ZgNMv7lN67ixIp162wrM7OJuaOif872QijSceRdZhzaMGImAwB0D4MosRV4WMBOKkwgPdmS7GuZN66YUidXk3wTGqX3MYRw6M0kj4eNegSUwPXvp4q4p0KO8Y3xUMld54GY2ApX3WN3CBtC/vpJqEszjGBbbGg=="
}
```

response — 订单失败

```json theme={null}
{
"status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M1234567111",
        "orderNo": "3022111516571436",
        "amount": "2000.00",
        "fee": "0.00",
        "status": 3,
        "errorMsg": "Đơn hàng không tồn tại",
        "sign": "KKuvCl0SuNANJs+l2ogDaJm8pmV+Hi+Xa7q27vJ6D1Ehs4aOp13kRbITfJAhczh3T81BE9qwHeJaYwf+r0EypKM9TL6pMwfG8Az4gRy1D57wiUaVjl2PWcvbEqrn1hL0b+btkjvAM9I+CcSv+wuOW3/uku17Ws3FhgJLj9sFsQUBAPjDO+758VnwBytCOLBmljLBXyKgNgpmFQ1/DNkqWl0UNzyLK45Zw3yf5NiwhEFbvW0jlOWlfu/ql4hluISUQG573jEoFCBEnQLb2tQoRZj1QYNRCXPf5lbej0vzqbEwvR9h+ZOf255t1MocJkdIe463DTV5U3KZdVT87HMagw=="
}
}
```

response — 订单成功

```json theme={null}
{
"status": "1",
    "error": "00000000",
    "msg": "",
    "data": {
    "orderId": "M1234567112",
        "orderNo": "3022111517401574",
        "amount": "2000.00",
        "fee": "1003.00",
        "status": 2,
        "payTime": "2024-03-01 23:59:59",
        "sign": "khPtOmGq+cpKX0HFAI/lbP0dx4oVyNAnL5oLsdmhDJdASlQm0yg5I3o+MhImYggEsL6c2bo5fP29t54OZFqSdQDfIuNDvGbAMAr4mRBxc0hoHLkBLyyagfVPBLyQA1JY8XV3ZL4ySzQ3ZQnMCfrh2K39ueUuz6HpZ03Hj0KYijVRCXAZaio/L5jfLBT12QXmvIfAHa8s/k9flhK05ENHPep3zjj/MZGOEaX7jkEJLfjK0duypDCa61BRQjM+oePOdVsgleIl1Yf98UAxMDZ/A3912KFHEb+/jvmdnulNbiJFyuT1fEe+j2teUgw3vFsZAtwNWAgxhC7UO+N0Q5z4EA=="
}
}
```

返回data参数说明

| 参数名      | 类型      | 说明                                                  |
| :------- | :------ | :-------------------------------------------------- |
| orderId  | String  | 商户订单号(必须保证唯一性)                                      |
| orderNo  | String  | 平台订单号                                               |
| amount   | String  | 交易金额                                                |
| fee      | String  | 手续费                                                 |
| status   | Integer | 状态(0未开始，1支付中，2成功（终态），3失败（终态）, -1异常待确认)              |
| payTime  | String  | 支付成功时间（当status=2时有值）(韩国时间), 格式: yyyy-MM-dd HH:mm:ss |
| errorMsg | String  | 支付失败原因（当status=3时有值）                                |
| sign     | String  | 签名                                                  |

### **支付方式**

| 币种  | 支付类型(accountType) | 支付编码(bankCode) | 限额           | 状态 | 说明                                 |
| --- | ----------------- | -------------- | ------------ | -- | ---------------------------------- |
| KRW | BANK\_ACCOUNT     | KOPOKRS1       | 1000-1500000 | 可用 | Korea Post(Epost)                  |
| KRW | BANK\_ACCOUNT     | KWABKRSE       | 1000-1500000 | 可用 | Kwangju Bank(KJ)                   |
| KRW | BANK\_ACCOUNT     | KYNAKR22       | 1000-1500000 | 可用 | Kyongnam Bank                      |
| KRW | BANK\_ACCOUNT     | NACFKRSE       | 1000-1500000 | 可用 | Nonghyup Bank(NH)                  |
| KRW | BANK\_ACCOUNT     | NFFCKRSE       | 1000-1500000 | 可用 | Suhyup Local Cooperatives          |
| KRW | BANK\_ACCOUNT     | PUSBKR2P       | 1000-1500000 | 可用 | Busan Bank(BNK)                    |
| KRW | BANK\_ACCOUNT     | KODBKRSE       | 1000-1500000 | 可用 | Korea Development Bank(KDB)        |
| KRW | BANK\_ACCOUNT     | SCBLKRSE       | 1000-1500000 | 可用 | Standard Chartered Korea(SC First) |
| KRW | BANK\_ACCOUNT     | SHBKKRSE       | 1000-1500000 | 可用 | Shinhan Bank                       |
| KRW | BANK\_ACCOUNT     | SSISKRSS       | 1000-1500000 | 可用 | Shinhan Investment                 |
| KRW | BANK\_ACCOUNT     | HVBKKRSE       | 1000-1500000 | 可用 | Woori Bank                         |
| KRW | BANK\_ACCOUNT     | CITIKRSXKAK    | 1000-1500000 | 可用 | K Bank                             |
| KRW | BANK\_ACCOUNT     | CZNBKRSE       | 1000-1500000 | 可用 | Kookmin-Bank(KB)                   |
| KRW | BANK\_ACCOUNT     | DAEBKR22       | 1000-1500000 | 可用 | Daegu Bank(DGB)                    |
| KRW | BANK\_ACCOUNT     | DEUTKRSE       | 1000-1500000 | 可用 | Deutsche Bank                      |
| KRW | BANK\_ACCOUNT     | ETSIKRS1       | 1000-1500000 | 可用 | eBEST Investment and Securities    |
| KRW | BANK\_ACCOUNT     | HNBNKRSE       | 1000-1500000 | 可用 | KEB Hana Bank                      |
| KRW | BANK\_ACCOUNT     | HSBCKRSE       | 1000-1500000 | 可用 | HSBC                               |
| KRW | BANK\_ACCOUNT     | CITIKRSX       | 1000-1500000 | 可用 | Citibank Korea                     |
| KRW | BANK\_ACCOUNT     | IBKOKRSE       | 1000-1500000 | 可用 | Industrial Bank of Korea(IBK)      |
| KRW | BANK\_ACCOUNT     | JEONKRSE       | 1000-1500000 | 可用 | Jeonbuk Bank(JB)                   |
| KRW | BANK\_ACCOUNT     | JJBKKR22       | 1000-1500000 | 可用 | Jeju Bank                          |
| KRW | BANK\_ACCOUNT     | KAKOKR22       | 1000-1500000 | 可用 | KAKAO Bank                         |

## 相关主题

* [公共接口](/docs/zh/api/version2/CommonApi)
* [HaiPay 接口说明与公共规则](/docs/zh/guide/api_description_guide)
* [香港地区支付接口](/docs/zh/api/version2/HongKong)
