Skip to content

Create pay-in

API TEST CONSOLE

Test request

TEST ONLY

Configure parameters and send a request to the test environment

POST/trade/payment/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/payment/create

Request headers

Common request headers.

Payment method values

paymentType
VA
KYC_VA_DYNAMIC
KAKAOPAY
TOSSPAY

Request parameters

FieldTypeRequiredMaximum lengthDescription
merchantOrderNoStringYes32Merchant order number
transactionAmountStringYes20Pay-in amount
paymentTypeStringYes24Payment method
idTypeStringNo32Optional ID type. For South Korean pay-ins, userIdCard is the merchant platform’s user ID, not a resident-registration ID.
userIdCardStringYes50Merchant platform user ID, not a resident registration number (RRN). Required for all payment methods; maximum 50 characters.
userNameStringYes64User name
userPhoneStringConditionally required11User mobile number, 11 digits; starts with 010. Required when paymentType is TOSSPAY.
userEmailStringConditionally required50User email. Required when paymentType is KAKAOPAY.
bankCodeStringNo64Bank codes
bankAccountNoStringNo64Bank account number
merchantNameStringYes64Merchant name
descriptionStringNo100Description
accountHolderNumberStringConditionally required20Required when the merchant enables account-holder identity validation. For an individual, enter the first 6 digits of the resident registration number (YYMMDD); for a business, enter the 10-digit business registration number.
ipAddressStringConditionally required64Required when paymentType is KAKAOPAY or TOSSPAY.
channelStringNo24Payment methodextension field
expireTimeStringNo-Order expiration time (local time, format yyyy-MM-dd HH:mm:ss)
paymentCallbackUrlStringNo200Pay-in callback URL

Request example

{
"merchantOrderNo": "ORDER202609170001",
"transactionAmount": "100.00",
"paymentType": "VA",
"userIdCard": "USER123456",
"userName": "TEST USER",
"userPhone": "01012345678",
"userEmail": "user@example.com",
"merchantName": "TEST MERCHANT",
"paymentCallbackUrl": "https://merchant.example/callback"
}

Response parameters

FieldTypeRequiredMaximum lengthDescription
codeintYes-Status code; a value other than 200 indicates an error
dataObjectYes-Response body
data.merchantOrderNoStringYes24Merchant order number
data.tradeNoStringYes32Platform order number
data.transactionAmountStringYes-Pay-in amount, an integer or up to two decimal places
data.statusStringYes24Order status
data.paymentTypeStringYes24Payment method
data.failMsgStringNo200Order failure reason
data.paymentInfoStringNo200Payment information
data.additionalObjectNo-Additional information
msgStringNo-Error message
tidStringYes-Trace ID

Response example

{
"code": 200,
"data": {
"merchantOrderNo": "ORDER202609170001",
"tradeNo": "VS2608270002KR0000000000040059",
"transactionAmount": "100.00",
"status": "PAYING",
"paymentType": "VA",
"paymentInfo": "PAYMENT_INFORMATION"
},
"msg": "success",
"tid": "747bbf80261844ed85b809212aab0d81"
}