跳转到内容

创建代收

请求地址

methodurl
POST/api/pay/payment/create/v1

头部信息(header)

header 参数入参参数描述
timestamp请求时间戳
nonce随机值
countryCO
app_codeapp 编号

支持支付方式列表(paymentType)

支付方式名称PaymentType
PSE (网银支付 ACH)201
WALLET (nequi) 支付链接202
CHECKOUT (包含所有方式支付链接 )204
EFECTY (线下)205

请求参数

字段类型必需长度描述
merchantOrderNoStringyes32商户订单号
paymentTypeIntyes支付方式,详见上方支付方式列表
amountStringyes20代收金额,仅支持整数,比索
expirationTimeLongno过期时间
realNameStringyes64用户姓名
emailStringyes50用户邮箱:满足正则表达式即可
phoneStringyes50电话号码10位数,不包含区号
idCardNumberStringno50身份证号码: CC 10位数、CE 6-10位数、NIT 9位数
signStringyes签名
callbackUrlStringno200回调地址
请求示例
{
"realName": "TeemoPay",
"amount": "10000",
"phone": "1234567890",
"callbackUrl": "https://www.callbackexample.com",
"merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
"email": "TeemoPay@example.com",
"paymentType": 204,
"sign": "YOUR_SIGN"
}

返回参数

字段类型必需长度描述
merchantOrderNoStringyes32商户订单号
tradeNoStringyes32平台订单号
amountStringyes32交易金额
paymentTypeIntyes3支付方式
paymentInfoStringyes32主要付款信息,返回的是实际用于付款的信息,例如:付款编号
additionalInfoJSONObjectno扩展信息
statusIntyes代收状态, 1:成功 3:失败
errorMsgStringno错误信息,失败时返回
{
"msg": "success",
"traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610299",
"code": 200,
"data": {
"amount": "10000",
"tradeNo": "TS2405220001CO0000430564883184",
"merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
"paymentType": 204,
"additionalInfo": {
},
"paymentInfo": "https://www.paymentLinkExample.com",
"status": 1
}
}

校验错误码

异常码异常信息处理方案
412Please try again later请稍后重试
414*更改对应参数
423This payment method is not supported对应支付方式不支持,请查阅文档,如存在则联系我们配置
426merchant order duplicate请更换商户订单号
427The callback notification address for collection must not be empty.请配置代收回调地址
466Payment method fee rate not configured.商户代收费率配置异常,请联系我们
473Merchant joint verification error: *商户配置异常,请联系我们
500Business Error请联系我们
返回示例
{
"code": 426,
"data": null,
"msg": "merchant order duplicate",
"traceId": "f2b58c9c394d4b1595dd4e448ac741bc.2256.17645844263770017"
}

渠道错误信息

errorMsg说明
Transaction amount exceeds limit, kindly retry within allowed range.请求金额超限
Channel request error, technicians will fix ASAP.渠道维护
Unstable network, kindly retry later.渠道网络波动
Parameter validation error, kindly verify and retry.参数上传有误
Abnormal user account , kindly contact user to verify account and retry.账户异常
返回示例
{
"code": 200,
"data": {
"merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
"amount": null,
"tradeNo": "TS2405220001CO0000430564883184",
"paymentType": 201,
"paymentInfo": null,
"additionalInfo": null,
"status": 3,
"errorMsg": "Transaction amount exceeds limit, kindly retry within allowed range."
},
"msg": "success",
"traceId": "f2b58c9c394d4b1595dd4e448ac741bc.1248.17645838103706945"
}