Supefina Payment API文档
  • 欢迎使用Supefina的API文档
    • 快速开始
    • 签名算法
    • 通知回调说明
    • 代收收银台(只支持电商行业的商户)
      • 🇲🇽墨西哥
      • 🇵🇪秘鲁
    • 代收
      • 🇲🇽墨西哥
        • SPEI
        • Cash
        • Card
        • 代收模拟(SPEI)
        • 代收模拟(Cash和Card)
      • 🇨🇴哥伦比亚
        • PSE
        • Bancolombia
        • Cash
        • All-Checkout
        • 代收模拟
      • 🇵🇪秘鲁
        • Transfer
        • Cash
        • Wallet
        • Card
        • 代收模拟
      • 🇨🇱智利
        • Card
        • Cash
        • Transfer
        • Wallet
        • All-Checkout
        • 代收模拟
      • 🇧🇷巴西
        • PIX
        • 代收模拟
      • 🇪🇨厄瓜多尔
        • Transfer
        • Cash
        • Card
        • Wallet
        • 代收模拟
      • 🇦🇷阿根廷
        • Debin
    • 代付
      • 🇲🇽墨西哥
        • SPEI
        • 代付失败原因说明
        • 代付模拟
      • 🇨🇴哥伦比亚
        • Transfer
        • Transfiya
        • 代付失败原因说明
        • 代付模拟
      • 🇵🇪秘鲁
        • Transfer
        • 代付失败原因说明
        • 代付模拟
      • 🇨🇱智利
        • Transfer
        • 代付模拟
      • 🇧🇷巴西
        • PIX
        • 代付失败原因说明
        • 代付模拟
      • 🇪🇨厄瓜多尔
        • Transfer
        • EC Transfer
        • 代付模拟
      • 🇦🇷阿根廷
        • Transfer
    • 查询
      • 交易查询
      • 余额查询
      • 凭证查询
      • 结算状态查询
    • 字典和资源
      • 响应状态码
      • 字典表
      • 下载
      • 测试参数
    • 更新记录
由 GitBook 提供支持
在本页
  • 目前支持的支付产品
  • 支付流程(具体支付方式的流程请查看代收列表中的文档)
  • 请求地址
  • 请求参数
  • 请求示例
  • 响应参数
  • 响应示例 — 成功
  • 响应示例 — 失败
  • 回调通知 — 提交方式:POST
  1. 欢迎使用Supefina的API文档
  2. 代收收银台(只支持电商行业的商户)

墨西哥

(多种支付方式集成)

目前支持的支付产品

  1. Cash

  2. SPEI

  3. Card

支付流程(具体支付方式的流程请查看代收列表中的文档)

  1. 用户在商户网站进行下单付款.

  2. 商户向Supefina发起API支付请求.

  3. Supefina返回聚合收银台地址以及相关单号数据.

  4. 用户在收银台上选择相关的支付方式并进行付款操作.

  5. Supefina通知商户订单成功.

请求地址

环境名称
URL

SandBox

POST http://8.130.9.219:8899/api/supefina/transactions/payin

正式环境

POST https://api.supefina.net/api/supefina/transactions/payin

请求参数

请求头

Key
Value

Content-Type

application/json

请求体

变量名
类型
必填
描述

merOrderNo

String

是

商户订单号

countryId

String

是

customerName

String

是

客户姓名

orderAmount

BigDecimal

是

订单金额(只支持固额付款) 1. 如果用户付款金额与下单金额不一致,我们进行相关的退款操作,如果无法退款会有相关运营联系。 2. 如果用户在收银台有效期外进行付款操作,我们也会进行相关的退款操作,如果无法退款会有相关运营联系。 3. 退款操作针对不同的支付方式会收取相关的手续费,请知悉。 4. 手续费金额可联系运营人员。

merId

String

是

商户ID 商户ID获取路径:Supefina商户后台-商户管理-基本信息-商户I

currency

String

是

checkOut

Boolean

是

拉取聚合收银台条件 此模式下只支持传入true

description

String

是

付款相关描述

nonceStr

String

是

随机字符串 长度不能超过32位

sign

String

是

payProduct

String

否

callbackUrl

String

否

回调地址

expireTimeL

Long

否

收银台过期时间(单位秒) 1. 如果不传入默认12H 2.如果传入的时间小于3分钟或者大于7天,我们也会默认为12H

requestData

Object

否

额外参数 注意:如果商户配置了Cash的支付方式,此参数必传。

businessUnit

Object

是

业务单位

name

String

是

业务单位的名称

key

String

是

业务单位的唯一标识

showHtmlFlag

String

是

展示html收款页

收款页URL:1

repeat

Boolean

否

Clabe是否重复使用 注意:如果指定payProduct为15(SPEI),此参数必传 true:多次使用

productName

String

是

商品名称 最大50个字符 如果商户配置了Card的支付方式,此参数必传

email

String

否

顾客邮箱 3-256个字符 如果商户配置了Card的支付方式,此参数必传

receiverAddressMain

String

否

收件地址,街道 0-50个字符 如果商户配置了Card的支付方式,此参数必传

receiverAddressExtra

String

否

收件地址,小区,门牌号 0-50个字符 如果商户配置了Card的支付方式,此参数必传

receiverCity

String

否

收件人城市 0-50个字符,可包括空格、连字符、撇号、逗号和点 如果商户配置了Card的支付方式,此参数必传

receiverProvince

String

否

receiverCountry

String

否

receiverZipCode

String

否

邮政编码 0-12个字母或数字 如果商户配置了Card的支付方式,此参数必传

receiverPhone

String

否

收件人电话 5-20个字符,区添加区号。如:+1 111111111 如果商户配置了Card的支付方式,此参数必传

请求示例

  1. 开通全部支付方式 — 不传入payProduct

{
    "merOrderNo": "20240920195501",
    "sign": "xxxx",
    "requestData": {
        "businessUnit": {
            "key": "11",
            "name": "123456"
        },
        "showHtmlFlag": "1"
    },
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxx",
    "productName": "test1",
    "email": "xxxx",
    "receiverAddressMain": "xxxx",
    "receiverAddressExtra": "xx",
    "receiverCity": "xxxx",
    "receiverCountry": "MEX",
    "receiverPhone": "+86123456789012345",
    "receiverProvince": "Example city",
    "receiverZipCode": "xxx",
    "description": "supefina",
    "expireTimeL": 3600
}
  1. 开通部分支付方式(Cash和SPEI) — 不传入payProduct

{
    "merOrderNo": "20240920195501",
    "sign": "xxxx",
    "requestData": {
        "businessUnit": {
            "key": "1098345673212",
            "name": "epay"
        },
        "showHtmlFlag": "1"
    },
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xxx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxx",
    "description": "supefina",
    "expireTimeL": 3600
}
  1. 开通部分支付方式(Cash和Card) — 不传入payProduct

{
    "merOrderNo": "20240920195501",
    "sign": "xxxx",
    "requestData": {
        "businessUnit": {
            "key": "11",
            "name": "123456"
        },
        "showHtmlFlag": "1"
    },
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxx",
    "productName": "test1",
    "email": "xxxx",
    "receiverAddressMain": "xxxx",
    "receiverAddressExtra": "xx",
    "receiverCity": "xxxx",
    "receiverCountry": "MEX",
    "receiverPhone": "+86123456789012345",
    "receiverProvince": "Example city",
    "receiverZipCode": "xxx",
    "description": "supefina",
    "expireTimeL": 3600
}
  1. 传入指定的支付方式

  • payProduct:03

{
    "merOrderNo": "20240920195501",
    "sign": "xxxxxx",
    "requestData": {
        "businessUnit": {
            "key": "111",
            "name": "123456"
        },
        "showHtmlFlag": "1"
    },
    "payProduct":"03",
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xxx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxxxx",
    "description": "supefina",
    "expireTimeL": 3600
}
  • payProduct:15

{
    "merOrderNo": "20240920195501",
    "sign": "xxxxx",
    "payProduct":"15",
    "repeat":true,
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xxxx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxxxx",
    "description": "supefina",
    "expireTimeL": 3600
}
  • payProduct:18

{
    "merOrderNo": "20240920195501",
    "sign": "xxxxxxx",
    "payProduct":"18",
    "countryId": "MEX",
    "nonceStr": "20240920195501",
    "customerName": "xxxx",
    "orderAmount": 100,
    "merId": "xxxxx",
    "checkOut": "true",
    "currency": "MXN",
    "callbackUrl": "xxxxx",
    "productName": "test1",
    "email": "xxxxxx",
    "receiverAddressMain": "xxxxxx",
    "receiverAddressExtra": "xxxxx",
    "receiverCity": "Example city",
    "receiverCountry": "MEX",
    "receiverPhone": "+86123456789012345",
    "receiverProvince": "Example city",
    "receiverZipCode": "xxxxx",
    "description": "supefina",
    "expireTimeL": 3600
}

响应参数

变量名
类型
描述

code

String

msg

String

响应描述

data

Object

响应数据

merCode

String

商户ID

merOrderNo

String

商户订单号

supefinaOrderNo

String

Supefina订单号

amount

BigDecimal

订单金额

url

String

交易链接

currency

String

币种

响应示例 — 成功

{
    "code": "200",
    "msg": "success ",
    "data": {
        "merCode": "xxxxx",
        "merOrderNo": "20240920195501",
        "supefinaOrderNo": "2025011877286055912513536",
        "amount": 100,
        "url": "http://h5.supefina.tech/combineCashier?token=3eeec61dc9544b41b9086e953b52571c",
        "currency": "MXN"
    }
}

响应示例 — 失败

{
    "code": "400",
    "msg": "param error : requestData is null"
}

回调通知 — 提交方式:POST

变量名
类型
描述

amount

String

订单金额

countryId

String

fee

String

预收手续费

identifier

String

付款参考 Clabe

merId

String

商户ID

merOrderId

String

商户订单号

msg

String

响应描述

nonceStr

String

随机字符串 长度不能超过32位

realityAmount

String

实收金额

realityFee

String

实收手续费

reference

String

标识符

sign

String

签名

status

String

successTime

Date

交易成功时间 UTC时间

supefinaOrderId

String

supefina订单号

transactionType

String

交易类型 01:代收

回调通知示例

{
    "amount": "30.00",
    "countryId": "MEX",
    "fee": "3.30",
    "identifier": "706180968985601627",
    "merId": "8302636872670229",
    "merOrderId": "P1790641845848850466",
    "msg": "SUCCESS",
    "nonceStr": "03aeeb11-0ad8-42dd-9f00-be1aae",
    "realityAmount": "30.00",
    "realityFee": "3.30",
    "reference": "3843CP03202405190062858560",
    "sign": "27C5933E426DD7A9EABD5C9D50F6BEBE",
    "status": "01",
    "successTime": 1715757366244,
    "supefinaOrderId": "202405150301469d1e0b38e7fdc46",
    "transactionType": "01"
}

回调通知响应

商户成功收到回调后需同步返回指定字符串:SUCCESS 不返回或返回其他内容默认通知失败 如:

public String test(){
	return "SUCCESS";
}
上一页代收收银台(只支持电商行业的商户)下一页秘鲁

最后更新于4个月前

国家编号 参照: 墨西哥:MEX

币种 参照: 墨西哥比索:MXN

签名

如果不传入则拉取商户配置下全部支付方式的收银台。 如果传入相关支付方式,则收银台上只展示对应的支付方式。 注意: 如果此时传入没有配置的支付方式会返回异常信息。

详见

收件人所在省 0-40个字符 参数: 例:NY 如果商户配置了Card的支付方式,此参数必传

收件人国家 参照: 例:BRA 如果商户配置了Card的支付方式,此参数必传

响应编码 具体参照:

国家编号 参照: 墨西哥:MEX

具体参照:

🇲🇽
具体参照:签名算法
通知回调说明
https://en.wikipedia.org/wiki/ISO_3166-2
字典表-国家编号
响应状态码
字典表-国家编号
字典表-货币
支付类型
字典表-国家编号
交易状态
字典表——交易订单状态