HaiPay

English

简体中文

English

简体中文

Appearance

South Korea Payment API

About 2761 wordsAbout 9 min

Warning

Before reading this API documentation, be sure to review the API Description Guide

Limits

Transaction TypeLimit
CollectionUSD: 0.99-1000, KRW: 1000-1500000
PayoutKRW: 1000-1500000

Collection API

Collection Application

Brief Description:

  • Create a collection order

URL:

KRW: /krw/collect/apply Note: appId for KRW, amount in KRW, settlement in KRW

USD: /usd/collect/apply Note: appId for USD, amount in USD, settlement in USD

Parameters:

Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, must pass corresponding business ID based on currency in URL)
orderIdYesStringMerchant order number (must be unique, length not exceeding 48)
nameYesStringUser name, recommended to use real name, format: firstName and lastName separated by space, example: Donald John Trump
phoneYesStringReal phone number (format reference Phone Number Format)
emailYesStringReal email address
amountYesStringTransaction amount (accurate to two decimal places; do not add punctuation, e.g., ",") Range reference: Collection code
payTypeYesStringTransaction type
inBankCodeYesStringPayment method
callBackUrlYesStringURL to redirect after successful payment
callBackFailUrlYesStringURL to redirect after failed payment
notifyUrlNoStringCallback URL
subjectNoStringPayment remark
countryNoStringCashier mode requires this parameter, please pass: 410
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), used for risk control, must be real and valid, otherwise it will affect transactions. Format requirements: digits, uppercase and lowercase letters or common symbols -~!@#$%&*()_.
signYesStringSignature

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
payUrlStringPayment link
signStringSignature

Collection Query

Brief Description:

  • Query collection order

URL:

KRW: /krw/collect/query

USD: /usd/collect/query

Parameters:

Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, must pass corresponding business ID based on currency in URL)
orderIdYesStringMerchant order number
orderNoNoStringPlatform order number (faster response)
signYesStringSignature

request

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

response

{
  "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=="
  }
}

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
actualAmountStringAmount received
feeStringHandling fee
statusIntegerStatus (0 - Not started, 1 - In progress, 2 - Success (final state), 3 - Failure (final state), -1 - Pending confirmation)
payTimeStringPayment success time (available when status=2) (local time), format: yyyy-MM-dd HH:mm:ss
errorMsgStringPayment failure reason (available when status=3)
signStringSignature

Payment Methods

CurrencyPayment Type (payType)Payment Code (inBankCode)LimitsStatusDescription
KRWEWALLETKAKAOPAY_KRW 1000-1500000AvailableKakao Pay Wallet
KRWEWALLETNAVERPAY_KRW1000-1500000AvailableNaver Pay Wallet
KRWEWALLETTOSS_KRW 1000-1500000AvailableToss Pay Wallet
KRWEWALLETSAMSUNGPAY_KRW 1000-1500000AvailableSamsung Pay Wallet
KRWEWALLETPAYCO_KRW 1000-1500000AvailablePayCo Wallet
KRWBANK_TRANSFERBANK_KRW1000-1500000AvailableBank account authorization payment (supports all Korean banks)
KRWVA (Virtual Account)VA_BANK_KRW300-500000Available Virtual Account Cashier
KRWVA (Virtual Account)KOOKMIN_BANK300-500000AvailableSupported Bank: Kookmin Bank
KRWVA (Virtual Account)SHBKKRSE300-500000AvailableSupported Bank: Shinhan Bank
KRWVA (Virtual Account)HANA_BANK300-500000AvailableSupported Bank: Hana Bank
KRWVA (Virtual Account)WOORI_BANK300-500000AvailableSupported Bank: Woori Bank
KRWVA (Virtual Account)NONGHYUP_BANK300-500000AvailableSupported Bank: Nonghyup Bank
KRWVA (Virtual Account)IBK300-500000AvailableSupported Bank: IBK
KRWVA (Virtual Account)SC_BANK300-500000AvailableSupported Bank: SC Bank
KRWVA (Virtual Account)KBANK300-500000AvailableSupported Bank: Kbank
KRWVA (Virtual Account)SUHYUP300-500000AvailableSupported Bank: Suhyup
KRWVA (Virtual Account)DAEGU_BANK300-500000AvailableSupported Bank: Daegu Bank
KRWVA (Virtual Account)BUSAN_BANK300-500000AvailableSupported Bank: Busan Bank
KRWVA (Virtual Account)KYONGNAM_BANK300-500000AvailableSupported Bank: Kyongnam Bank
KRWVA (Virtual Account)KWANGJU_BANK300-500000AvailableSupported Bank: Kwangju Bank
KRWVA (Virtual Account)KFCC300-500000AvailableSupported Bank: Korea Federation of Community Credit Cooperatives
KRWVA (Virtual Account)KOREA_POST300-500000AvailableSupported Bank: Korea Post
USDEWALLETKAKAOPAY_USD0.99-1000AvailableKakao Pay Wallet
USDEWALLETNAVERPAY_USD0.99-1000AvailableNaver Pay Wallet
USDEWALLETTOSS_USD 0.99-1000AvailableToss Pay Wallet
USDEWALLETSAMSUNGPAY_USD 0.99-1000AvailableSamsung Pay Wallet
USDEWALLETPAYCO_USD 0.99-1000AvailablePayCo Wallet
USDBANK_TRANSFERKR_BANK_USD0.99-1000AvailableBank account authorization payment (supports all Korean banks)

Payout API

Payout Application

Brief Description:

  • Create a payout order

URL: /krw/pay/apply

Parameters:

Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, must pass corresponding business ID based on currency in URL)
orderIdYesStringMerchant order number (must be unique, length not exceeding 48)
amountYesStringTransaction amount (unit: ₩, accurate to two decimal places; do not add punctuation, e.g., ",")
accountTypeYesStringAccount type: BANK_ACCOUNT (bank account)
bankCodeYesStringBank code (see Appendix: Payout Bank Codes)
accountNoYesStringUser bank account number
nameYesStringRecipient name (format: uppercase and lowercase letters with spaces allowed, 1-30 characters, "firstName middleName lastName" (middleName is optional, special characters supported: .-))
phoneYesStringPhone number
emailYesStringEmail address
notifyUrlNoStringCallback URL
subjectNoStringPayment remark
bodyNoStringRemark details
partnerUserIdYesStringUnique user identifier (e.g., userId), used for risk control, must be real and valid, otherwise it will affect transactions. Format requirements: digits, uppercase and lowercase letters or common symbols -~!@#$%&*()_.
signYesStringSignature

request (when accountType is BANK_ACCOUNT type)

{
  "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

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

Response data parameter description

Parameter NameRequiredType
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
signStringSignature

Payout Query

Brief Description:

  • Query payout order

URL: /krw/pay/query

Parameters:

Parameter NameRequiredTypeDescription
appIdYesLongBusiness ID (obtained from backend, must pass corresponding business ID based on currency in URL)
orderIdYesStringMerchant order number
orderNoNoStringPlatform order number (faster response)
signYesStringSignature

request

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

response — Order Failed

{
  "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 — Order Successful

{
  "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=="
  }
}

Response data parameter description

Parameter NameTypeDescription
orderIdStringMerchant order number (must be unique)
orderNoStringPlatform order number
amountStringTransaction amount
feeStringHandling fee
statusIntegerStatus (0 - Not started, 1 - In progress, 2 - Success (final state), 3 - Failure (final state), -1 - Pending confirmation)
payTimeStringPayment success time (available when status=2) (Korean time), format: yyyy-MM-dd HH:mm:ss
errorMsgStringPayment failure reason (available when status=3)
signStringSignature

Payment Methods

CurrencyPayment Type (accountType)Payment Code (bankCode)LimitsStatusDescription
KRWBANK_ACCOUNTSAMCKRSL1000-1500000AvailableSamsung Securities
KRWBANK_ACCOUNTKOPOKRS11000-1500000AvailableKorea Post(Epost)
KRWBANK_ACCOUNTKWABKRSE1000-1500000AvailableKwangju Bank(KJ)
KRWBANK_ACCOUNTKYBOKRSE1000-1500000AvailableKyobo Securities
KRWBANK_ACCOUNTKYNAKR221000-1500000AvailableKyongnam Bank
KRWBANK_ACCOUNTMHCBKRSE1000-1500000AvailableMirae Asset Daewoo
KRWBANK_ACCOUNTNACFKRSE1000-1500000AvailableNonghyup Bank(NH)
KRWBANK_ACCOUNTNFFCKRSE1000-1500000AvailableSuhyup Local Cooperatives
KRWBANK_ACCOUNTPUSBKR2P1000-1500000AvailableBusan Bank(BNK)
KRWBANK_ACCOUNTKODBKRSE1000-1500000AvailableKorea Development Bank(KDB)
KRWBANK_ACCOUNTSCBLKRSE1000-1500000AvailableStandard Chartered Korea(SC First)
KRWBANK_ACCOUNTSECDKRS11000-1500000AvailableDaishin Securities
KRWBANK_ACCOUNTSEOSKRS11000-1500000AvailableEugene Investment and Securities
KRWBANK_ACCOUNTSHBKKRSE1000-1500000AvailableShinhan Bank
KRWBANK_ACCOUNTSHHEKRS11000-1500000AvailableHyundai Motor Securities
KRWBANK_ACCOUNTSKSEKRS11000-1500000AvailableSK Securities
KRWBANK_ACCOUNTSSISKRSS1000-1500000AvailableShinhan Investment
KRWBANK_ACCOUNTWISHKRSE1000-1500000AvailableNH Investment and Securities
KRWBANK_ACCOUNTHVBKKRSE1000-1500000AvailableWoori Bank
KRWBANK_ACCOUNTCITIKRSXKAK1000-1500000AvailableK Bank
KRWBANK_ACCOUNTCZNBKRSE1000-1500000AvailableKookmin-Bank(KB)
KRWBANK_ACCOUNTDAEBKR221000-1500000AvailableDaegu Bank(DGB)
KRWBANK_ACCOUNTDEUTKRSE1000-1500000AvailableDeutsche Bank
KRWBANK_ACCOUNTETSIKRS11000-1500000AvailableeBEST Investment and Securities
KRWBANK_ACCOUNTHNBNKRSE1000-1500000AvailableKEB Hana Bank
KRWBANK_ACCOUNTHNWSKRSS1000-1500000AvailableHanhwa Investment and Securities
KRWBANK_ACCOUNTHSBCKRSE1000-1500000AvailableHSBC
KRWBANK_ACCOUNTCITIKRSX1000-1500000AvailableCitibank Korea
KRWBANK_ACCOUNTHYSEKRSE1000-1500000AvailableKB Securities
KRWBANK_ACCOUNTIBKOKRSE1000-1500000AvailableIndustrial Bank of Korea(IBK)
KRWBANK_ACCOUNTJEONKRSE1000-1500000AvailableJeonbuk Bank(JB)
KRWBANK_ACCOUNTJJBKKR221000-1500000AvailableJeju Bank
KRWBANK_ACCOUNTKAKOKR221000-1500000AvailableKAKAO Bank
KRWBANK_ACCOUNTKFBCKRSE1000-1500000AvailableMeritz Securities
KRWBANK_ACCOUNTKISEKRSE1000-1500000AvailableKorea Investment and Securities
KRWBANK_ACCOUNTKIWCKRSE1000-1500000AvailableKiwoom Securities

Theme by cotmier

Copyright © 2019-2025 HaiPay | MIT License