Skip to content

Create payout

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payout/create

Authentication

Not configured

The private key is used only in your browser to generate authorization. It is never sent or stored.

Request headers

Request body application/json

Response

Response
After you send the request, the status, duration, and JSON response appear here.

Authentication details remain only in this page's memory and are not written to local storage.

Copying cURL does not send a request

POST/trade/payout/create

Request headers

Common request headers.

Payment method values

payoutType
BANK_TRANSFER
BANKTRANSFER_KYC

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Payout amount, an integer or up to two decimal places
payoutTypeStringYes20Payout method
idTypeStringYes50Beneficiary type: RRN (individual) or CO (business)
userIdCardStringNo50ID number. An individual RRN contains 13 digits; a business CO contains the 10-digit business registration number. This field is optional for this endpoint.
userNameStringYes64User name
userPhoneStringNo11User mobile number, 11 digits; starts with 010
userEmailStringNo50User email
bankCodeStringYes20Bank codes
bankNameStringYes50Bank name
bankAccountNoStringYes50Beneficiary account
descriptionStringNo100Description
payoutCallbackUrlStringNo200Payout callback URL

Request example

{
"merchantOrderNo": "PAYOUT202609170001",
"transactionAmount": "100.00",
"payoutType": "BANK_TRANSFER",
"idType": "RRN",
"userIdCard": "9001011234567",
"userName": "TEST USER",
"userPhone": "01012345678",
"userEmail": "user@example.com",
"bankCode": "088",
"bankName": "Shinhan Bank",
"bankAccountNo": "1234567890",
"description": "Payout order",
"payoutCallbackUrl": "https://merchant.example/payout-callback"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes32Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Payout amount
data.statusStringYes24Order status
data.payoutTypeStringYes24Payout method
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"code": 200,
"data": {
"merchantOrderNo": "PAYOUT202609170001",
"tradeNo": "VF2405220001KR0000508467743993",
"transactionAmount": "100.00",
"status": "PAYING",
"payoutType": "BANK_TRANSFER"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}