跳转到内容

创建代收

请求地址

method	url
POST	/api/pay/payment/create/v1

header 参数	入参参数描述
timestamp	请求时间戳
nonce	随机值
country	CO
app_code	app 编号

支持支付方式列表（paymentType）

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

场景

什么是 BRE-B？

BRE-B 是哥伦比亚新一代互操作实时支付系统。用户通过复制页面生成的唯一支付密钥 (Key)，并粘贴到其银行 App 中完成付款。由于用户在 App 内手动输入金额，实际支付数额可能与订单不符。系统会根据实际到账情况发送回调通知，请务必以回调中的最终金额为准进行对账。

官方模拟器如何生成自己的BRE-B KEY： https://www.banrep.gov.co/es/bre-b/simuladores-curso#registro

请求参数

字段	类型	必需	长度	描述
merchantOrderNo	String	yes	32	商户订单号
paymentType	Int	yes		支付方式,详见上方支付方式列表
amount	String	yes	20	代收金额,仅支持整数,比索
expirationTime	Long	no		过期时间
realName	String	yes	64	用户姓名
email	String	yes	50	用户邮箱：满足正则表达式即可
phone	String	yes	50	电话号码10位数,不包含区号
idCardNumber	String	no	50	身份证号码: CC 10位数、CE 6-10位数、NIT 9位数当paymentType为201(PSE)和202(WALLET)的时候必填
idType	String	no	32	身份证类型: CC(6-10位数;身份证)、CE(6-10位数)、NIT(9位数;税号)、PA(9位数;护照) 当paymentType为201(PSE)和202(WALLET)的时候必填
bankCode	String	no	50	银行编码当paymentType为201(PSE)时必填参考创建代付的银行列表
sign	String	yes		签名
callbackUrl	String	no	200	回调地址

{
    "realName": "TeemoPay",
    "amount": "10000",
    "phone": "1234567890",
    "callbackUrl": "https://www.callbackexample.com",
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "email": "TeemoPay@example.com",
    "idType": "CC",
    "idCardNumber": "1234567890",
    "bankCode": 1040,
    "paymentType": 201,
    "sign": "YOUR_SIGN"
}

{
    "realName": "TeemoPay",
    "amount": "10000",
    "phone": "1234567890",
    "callbackUrl": "https://www.callbackexample.com",
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "email": "TeemoPay@example.com",
    "idType": "CC",
    "idCardNumber": "1234567890",
    "paymentType": 202,
    "sign": "YOUR_SIGN"
}

返回参数

字段	类型	必需	长度	描述
merchantOrderNo	String	yes	32	商户订单号
tradeNo	String	yes	32	平台订单号
amount	String	yes	32	交易金额
paymentType	Int	yes	3	支付方式
paymentInfo	String	yes	32	主要付款信息，返回的是实际用于付款的信息，例如：付款编号
additionalInfo	JSONObject	no		扩展信息
status	Int	yes		代收状态, 1:成功 3:失败
errorMsg	String	no		错误信息,失败时返回

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

校验错误码

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