Skip to content

Create a payout order

Request URL

methodurl
POST/api/pay/payout/create/v1

Header Information

Header ParameterParameter Description
timestampRequest timestamp
nonceRandom value
countryCountry code (KR)
app_codeApplication ID

Request Parameters

FieldTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant Order Number
amountStringyes20Payment Amount (for Disbursement) 【Integer, Unit: KRW (Korean Won)】
bankCodeStringyes50Bank Code 【Refer to the bank code in the bank list】
bankNameStringyes50Bank Name 【Refer to the bank name in the bank list】
accountTypeIntegeryesAccount Type 【801: BANK_TRANSFER】
bankAccountStringyes50Beneficiary’s Bank Account Number
realNameStringyes40User’s Real Name. No special characters allowed; uppercase is recommended. Must be at least 2 characters long. Strict verification is not required, but it must conform to normal name format.
idTypeStringyes50Beneficiary Type: RRN (Individual); CO (Enterprise)
callbackUrlStringno200Disbursement Callback URL. If not provided, the merchant’s configured URL will be used.
signStringyesSignature
Request
{
"merchantOrderNo": "OrderNoExample",
"amount": "1000",
"bankCode": "088",
"bankName": "Shinhan Bank",
"accountType": 801,
"bankAccount": "12345678998765",
"realName": "realName",
"idType": "RRN",
"callbackUrl": "https://www.callbackexample.com",
"sign": "YOUR_SIGN"
}

Return Parameters

ParameterTypeRequiredLengthDescription
merchantOrderNoStringyes32Merchant order number
tradeNoStringyesPlatform order number
statusIntyesReimbursement status 【1: Payment in progress 3: Failure (can be re-initiated)】
amountStringyesTransaction amount
Return
{
"merchantOrderNo": "OrderNoExample",
"tradeNo": "TF201806251011",
"status": 1,
"sign": "TEEMO_SIGN"
}