跳转到内容
Teemopay Docs

创建代收

请求地址

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

头部信息（header）

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

支持支付方式列表（paymentType）

支付方式名称PaymentType (入参参数)
VA (SPEI 线上网银支付)1
PayCashOnce（线下网点现金支付单次）4
PayCashRecurrent (线下网点现金支付同金额多次)5
OXXO (OXXO 线下网点现金支付)6

注意事项

  1. 当paymentType支付方式为1:VA,还款金额和次数由用户决定,可能出现不足额或者超过期望收款金额的情况,也可能出现多次还款的情况。商户必须正确处理该逻辑。多次还款时通过回调报文中paymentOrderNo字段作为每笔还款的唯一标识。
  2. 当paymentType支付方式为5:PayCashRecurrent,可能出现多次还款的情况。多次还款时通过回调报文中paymentOrderNo字段作为每笔还款的唯一标识。

请求参数

字段类型必需最大长度描述
merchantOrderNoStringyes32商户订单号
paymentTypeIntyes支付方式: 1:VA 4:PayCashOnce 5:PayCashRecurrent
realNameStringyes64用户姓名
emailStringno50用户邮箱：满足正则表达式即可
amountStringyes20代收金额(比索)
expirationTimeLongno过期时间 当 paymentType 为 4、5时有效,默认为一天 毫秒级时间戳 eg:1735660800000
phoneStringno20手机号
callbackUrlStringno200代付回调地址，若不传, 则以商户配置为准
signStringyes签名
请求示例
{
    "realName": "TeemoPay",
    "amount": "1000.00",
    "phone": "1000000000",
    "sign": "YOUR_SIGN",
    "callbackUrl": "https://www.callbackexample.com",
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "email": "TeemoPay@example.com",
    "paymentType": 1
}

返回参数

字段类型必需长度描述
merchantOrderNoStringyes32商户订单号
tradeNoStringyes32平台订单号
amountStringyes32交易金额
paymentTypeIntyes10支付方式 1:VA 4:PayCashOnce 5:PayCashRecurrent
paymentInfoStringyes32主要付款信息，返回的是实际用于付款的信息，例如：Va 账号，付款编号
additionalInfoJSONObjectno附加信息：辅助主要信息使用
statusIntyes1-订单创建成功 3-失败
errorMsgStringno错误信息,失败时返回

不同支付方式的响应示例

当 PaymentType 为 1 时（VA）：

{
  "msg": "success",
  "traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610299",
  "code": 200,
  "data": {
    "amount": "1000.00",
    "tradeNo": "TS2405220001MX0000430564883184",
    "additionalInfo": {
      "paymentLink": "https://test-mx-payin.teemopay.com/TS2405220001MX0000315772003922"
    },
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "paymentInfo": "684180093000000000",
    "paymentType": 1,
    "status": 1
  }
}

当 PaymentType 为 4 时（PayCashOnce）：

{
  "msg": "success",
  "traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610298",
  "code": 200,
  "data": {
    "amount": "1000.00",
    "tradeNo": "TS2405220001MX0000430564883184",
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "paymentType": 4,
    "additionalInfo": {
      "paymentLink": "https://www.paycashLinkExample.com"
    },
    "paymentInfo": "1420000000000",
    "status": 1
  }
}

当 PaymentType 为 5 时（PayCashRecurrent）：

{
  "msg": "success",
  "traceId": "747bbf80261844ed85b809212aab0d81.85.17422898158610297",
  "code": 200,
  "data": {
    "amount": "1000.00",
    "tradeNo": "TS2405220001MX0000430564883184",
    "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
    "paymentType": 4,
    "additionalInfo": {
      "paymentLink": "https://www.paycashLinkExample.com"
    },
    "paymentInfo": "1420000000000",
    "status": 1
  }
}

当 PaymentType 为 6 时（OXXO）：

{
  "amount": "1000.00",
  "tradeNo": "TS2405220001MX0000430564883184",
  "merchantOrderNo": "ABCDEFG",
  "paymentType": 6,
  "additionalInfo": {
    "paymentLink": "https://www.paycashglobXXXXXXXm/formato.php?referencia=ATQyMDY0OTczNDIzMg==&interno=1"
  },
  "paymentInfo": "1420649734231",
  "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.参数上传有误
返回示例
{
    "code": 200,
    "data": {
        "merchantOrderNo": "2C2741241kCApltr2IATMy0c992278",
        "amount": null,
        "tradeNo": "TS2405220001MX0000430564883184",
        "paymentType": 1,
        "paymentInfo": null,
        "additionalInfo": null,
        "status": 3,
        "errorMsg": "Transaction amount exceeds limit, kindly retry within allowed range."
    },
    "msg": "success",
    "traceId": "f2b58c9c394d4b1595dd4e448ac741bc.1248.17645838103706945"
}