Create pay-in
POST
/trade/payment/createRequest headers
Payment method values
paymentType |
|---|
VA |
KYC_VA_DYNAMIC |
KAKAOPAY |
TOSSPAY |
Request parameters
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
merchantOrderNo | String | Yes | 32 | Merchant order number |
transactionAmount | String | Yes | 20 | Pay-in amount |
paymentType | String | Yes | 24 | Payment method |
idType | String | No | 32 | Optional ID type. For South Korean pay-ins, userIdCard is the merchant platform’s user ID, not a resident-registration ID. |
userIdCard | String | Yes | 50 | Merchant platform user ID, not a resident registration number (RRN). Required for all payment methods; maximum 50 characters. |
userName | String | Yes | 64 | User name |
userPhone | String | Conditionally required | 11 | User mobile number, 11 digits; starts with 010. Required when paymentType is TOSSPAY. |
userEmail | String | Conditionally required | 50 | User email. Required when paymentType is KAKAOPAY. |
bankCode | String | No | 64 | Bank codes |
bankAccountNo | String | No | 64 | Bank account number |
merchantName | String | Yes | 64 | Merchant name |
description | String | No | 100 | Description |
accountHolderNumber | String | Conditionally required | 20 | Required 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. |
ipAddress | String | Conditionally required | 64 | Required when paymentType is KAKAOPAY or TOSSPAY. |
channel | String | No | 24 | Payment methodextension field |
expireTime | String | No | - | Order expiration time (local time, format yyyy-MM-dd HH:mm:ss) |
paymentCallbackUrl | String | No | 200 | Pay-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
| Field | Type | Required | Maximum length | Description |
|---|---|---|---|---|
code | int | Yes | - | Status code; a value other than 200 indicates an error |
data | Object | Yes | - | Response body |
data.merchantOrderNo | String | Yes | 24 | Merchant order number |
data.tradeNo | String | Yes | 32 | Platform order number |
data.transactionAmount | String | Yes | - | Pay-in amount, an integer or up to two decimal places |
data.status | String | Yes | 24 | Order status |
data.paymentType | String | Yes | 24 | Payment method |
data.failMsg | String | No | 200 | Order failure reason |
data.paymentInfo | String | No | 200 | Payment information |
data.additional | Object | No | - | Additional information |
msg | String | No | - | Error message |
tid | String | Yes | - | 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"}