Skip to main content

Create Withdrawal Order (Korea)

API for creating Korean Won (KRW) withdrawal orders.

Request Information

  • Request URL: /gateway/api/v2/payouts
  • Method: POST
  • Content-Type: application/json;charset=utf-8

Request Parameters

ParameterRequiredTypeDescription
platform_idYesString(6)Merchant ID
service_idYesString(7)Service ID
payout_cl_idYesString(64)Merchant Order ID
amountYesInteger(10)Amount (in cents)
notify_urlNoString(256)Callback URL for transaction results
bank_nameYesString(16)Bank code
nameYesString(16)Beneficiary name
numberYesString(32)Beneficiary account number
phone_numberYesString(11)Phone number
currencyYesString(3)Fixed value: krw
request_timeYesInteger(10)Request time (seconds)
sign_typeNoString(16)Signature type: HMAC-SHA256 (recommended) or MD5 (default)
signYesString(32|64)Order Signature

Service ID

  • SVC0004 Bank Card Withdrawal

Response Example

{
"error_code": "0000",
"data": { "payout_id": "POT00000001" }
}

Remarks

Important

In case of timeout or HTTP 500 errors, please use the order query API to check the status. Do not treat the order as failed directly.

  • Transaction amount is in Korean Won (cents)
  • A response of "0000" only indicates the API call was successful. Please use the query API to confirm the result