跳转到内容

代收创建

API TEST CONSOLE

模拟请求

TEST ONLY

测试环境下配置参数并发送请求

POST/trade/payment/create

请求鉴权

待配置

私钥仅在浏览器内用于生成 authorization,不会随请求发送或保存

请求头

请求参数 application/json

响应结果

Response
发送请求后,响应状态、耗时和 JSON 将显示在这里。

认证信息仅保留在当前页面内存中,不会写入本地存储。

复制 cURL 不会发送请求

POST/trade/payment/create

请求头

公共请求头。

支付方式参数

paymentType
VA
KYC_VA_DYNAMIC
KAKAOPAY
TOSSPAY

请求参数

字段类型必填最大长度说明
merchantOrderNoString是32商户订单号
transactionAmountString是20收款金额
paymentTypeString是24支付方式
idTypeString否32可选的证件类型;韩国代收的 userIdCard 是商户平台用户 ID,不要求传居民登记证件类型
userIdCardString是50证件号码(商户平台用户 ID,非居民登记号码 RRN)。所有支付方式均必填,最长 50 位
userNameString是64用户姓名
userPhoneString条件必填11用户手机号码,11 位数字,以 010 开头;paymentType 为 TOSSPAY 时必填
userEmailString条件必填50用户邮箱;paymentType 为 KAKAOPAY 时必填
bankCodeString否64银行编码
bankAccountNoString否64银行账户号
merchantNameString是64商户名称
descriptionString否100说明
accountHolderNumberString条件必填20商户开启账户持有人识别码校验时必填:个人填写居民登记号前 6 位(YYMMDD),企业填写 10 位事业者登录号
ipAddressString条件必填64paymentType 为 KAKAOPAY 或 TOSSPAY 时必填
channelString否24支付方式扩展字段
expireTimeString否-订单过期时间(国家当地时间,格式 yyyy-MM-dd HH:mm:ss)
paymentCallbackUrlString否200代收回调地址

请求示例

{
"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"
}

响应参数

字段类型必填最大长度说明
codeint是-状态码,非 200 代表异常
dataObject是-响应体
data.merchantOrderNoString是24商户订单号
data.tradeNoString是32平台单号
data.transactionAmountString是-收款金额,整数或保留 2 位小数
data.statusString是24订单状态
data.paymentTypeString是24支付方式
data.failMsgString否200订单失败原因
data.paymentInfoString否200支付信息
data.additionalObject否-附加信息
msgString否-异常信息
tidString是-traceId

响应示例

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