转账接口

转账接口

特定商户业务系统通过转账接口发起请求,BePay支付网关会给对应链的钱包地址进行转账。

接口说明

适用对象:普通商户 特约商户

请求URL:https://{BePay Domain}/api/crypto/transferOrder

请求方式:POST

请求类型:application/jsonapplication/x-www-form-urlencoded

请求参数

字段名
变量名
必填
类型
示例值
描述

商户号

mchNo

String(30)

M1621873433953

商户号

应用ID

appId

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

String(30)

商户生成的订单号

商户用户ID

mchUserId

String(30)

test001

商户处的用户ID(确保是唯一ID)

链代码

chain

String(30)

ETH

链代码,详细见 附件:链代码

代币符号

symbol

String(30)

USDT

代币符号,详细见 附件:代币符号

目标地址

toAddress

String(50)

收取加密货币的钱包地址

转账金额

amount

BigDecimal

10.00000000

转账金额,固定保留8位小数

转账备注

transferDesc

String(50)

是否后台审核

audit

Boolean

true

是否需要在自己的商户后台进行审核

异步通知地址

notifyUrl

String(128)

异步通知地址URL,只有传了该值才会发起回调

客户端IP

clientIp

String

扩展参数

extParam

String(512)

商户扩展参数,回调时会原样返回

请求时间

reqTime

long

1622016572190

请求接口时间,13位时间戳

接口版本

version

String(3)

1.0

接口版本号,固定:1.0

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名值,详见签名算法

签名类型

signType

String(32)

MD5

签名类型,目前只支持MD5方式

请求示例数据

{
  "audit": "true",
  "clientIp": "192.168.1.1",
  "extParam": "",
  "chain": "ETH",
  "symbol": "USDT",
  "sign": "84F606FA25A6EC4783BECC08D4FDC681",
  "reqTime": "1624005107",
  "version": "1.0",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "signType": "MD5",
  "mchNo": "M1623984572",
  "mchUserId": "test001",
  "toAddress": "0xBC8c393959e5d8f2C96B1D5a8262a6762747B98b",
  "amount": 10.00000000,
  "transferDesc": "",
  "mchOrderNo": "M1651929947306188803"
}

返回参数

字段名
变量名
必填
类型
示例值
描述

返回状态

code

int

0

0-处理成功,其他-处理有误,详见错误码

返回信息

msg

String(128)

签名失败

具体错误原因,例如:签名失败、参数格式校验错误

签名信息

sign

String(32)

CCD9083A6DAD9A2DA9F668C3D4517A84

对data内数据签名,如data为空则不返回

返回数据

data

String(512)

{}

返回下单数据,json格式数据

data数据格式

字段名
变量名
必填
类型
示例值
描述

转账单号

transferId

String(30)

U12021022311124442600

返回支付系统订单号

商户单号

mchOrderNo

String(30)

20160427210604000490

返回商户传入的订单号

错误码

errCode

String

上游渠道返回的错误码

错误描述

errMsg

String

Business Failed 失败

上游渠道返回的错误描述

返回示例数据

{
  "code": 0,
  "data": {
    "errCode": "0",
    "transferId": "P1651929947306188802",
    "mchOrderNo": "M1651929947306188803"
  },
  "msg": "SUCCESS",
  "sign": "F4DA202C516D1F33A12F1E547C5004FD"
}

转账通知

当订单支付成功时,支付网关会向商户系统发起回调通知。如果商户系统没有正确返回,支付网关会延迟再次通知。

接口说明

适用对象:普通商户 特约商户

请求URL:该链接是通过统一下单接口提交的参数notifyUrl设置,如果无法访问链接,商户系统将无法接收到支付中心的通知。

请求方式:POST

请求类型:application/x-www-form-urlencoded

通知参数

字段名
变量名
必填
类型
示例值
描述

转账订单号

transferId

String(30)

P12021022311124442600

返回转账系统订单号

商户号

mchNo

String(30)

M1621873433953

商户号

应用ID

appId

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

String(30)

20160427210604000490

返回商户传入的订单号

商户用户id

mchUserId

String(30)

商户处的用户ID

转账金额

amount

BigDecimal

100.00000000

转账金额,固定保留8位小数

矿工费

minerFee

BigDecimal

0.00001000

矿工费金额,固定保留8位小数

链代码

chain

String(30)

ETH

链代码,详细见 附件:链代码

代币符号

symbol

String(32)

USDT

代币符号,详细见 附件:代币符号

目标地址

toAddress

String(50)

收取加密货币的钱包地址

转账备注信息

transferDesc

Sting

订单状态

state

String(1)

2

支付订单状态 0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭

错误码

errCode

String

1002

渠道下单返回错误码

错误描述

errMsg

String

134586944573118714

渠道下单返回错误描述

扩展参数

extParam

String(512)

134586944573118714

商户扩展参数

创建时间

createdAt

String(13)

1622016572190

订单创建时间,13位时间戳

成功时间

successTime

String(13)

1622016572190

订单支付成功时间,13位时间戳

通知请求时间

reqTime

String(30)

1622016572190

通知请求时间,,13位时间戳

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名值,详见签名算法

> 返回结果

业务系统处理后同步返回给支付中心,返回字符串 success 则表示成功,返回非success则表示处理失败,支付中心会再次通知业务系统。(通知频率为0/30/60/90/120/150,单位:秒)

注意:返回的字符串必须是小写,且前后不能有空格和换行符。

通知示例数据

{
    "amount": 1,
    "appId": "6113805e42020495c62bd4cb",
    "createdAt": 1628818820011,
    "chain": "ETH",
    "entryType": "WX_CASH",
    "errCode": "OPENID_ERROR",
    "errMsg": "openid与商户appid不匹配【openid与商户appid不匹配】",
    "mchNo": "M1623997351",
    "mchOrderNo": "1628818820",
    "minerFee": 0.00001000,
    "reqTime": "1622016572190",
    "sign": "A262DBD3D6182E8A0AEC90EF820F2A5A",
    "state": 3,
    "symbol": "USDT",
    "sign": "A262DBD3D6182E8A0AEC90EF820F2A5A"
    "transferDesc": "测试",
    "transferId": "T202108130940200100001",
    "toAddress": "0xBC8c393959e5d8f2C96B1D5a8262a6762747B98b"
}

查询订单

商户通过该接口查询转账订单,支付网关会返回订单最新的数据

接口说明

适用对象:普通商户 特约商户

请求URL:https://{BePay Domain}/api/crypto/transferOrder/query

请求方式:POST

请求类型:application/jsonapplication/x-www-form-urlencoded

请求参数

字段名
变量名
必填
类型
示例值
描述

商户号

mchNo

String(30)

M1621873433953

商户号

应用ID

appId

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

转账订单号

transferId

String(30)

T20160427210604000490

BePay支付平台生成的转账单号,与mchOrderNo二者传一即可

商户转账单号

mchOrderNo

String(30)

20160427210604000490

商户生成的转账单号,与transferId二者传一即可

请求时间

reqTime

long

1622016572190

请求接口时间,13位时间戳

接口版本

version

String(3)

1.0

接口版本号,固定:1.0

签名

sign

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名值,详见签名算法

签名类型

signType

String(32)

MD5

签名类型,目前只支持MD5方式

请求示例数据

{
"appId":"60cc3ba74ee0e6685f57eb1e",
"sign":"D3C0CC231F3FC3D033650699BA099B39",
"signType":"MD5",
"reqTime":"1629106457",
"transferId":"T202108121543441860003",
"mchNo":"M1623997351",
"version":"1.0"
}

返回数据

字段名
变量名
必填
类型
示例值
描述

返回状态

code

int

0

0-处理成功,其他-处理有误,详见错误码

返回信息

msg

String(128)

签名失败

具体错误原因,例如:签名失败、参数格式校验错误

签名信息

sign

String(32)

CCD9083A6DAD9A2DA9F668C3D4517A84

对data内数据签名,如data为空则不返回

返回数据

data

String(512)

{}

返回下单数据,json格式数据

data数据格式

字段名
变量名
必填
类型
示例值
描述

转账订单号

transferId

String(30)

P12021022311124442600

返回转账系统订单号

商户号

mchNo

String(30)

M1621873433953

商户号

应用ID

appId

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

String(30)

20160427210604000490

返回商户传入的订单号

商户用户id

mchUserId

String(30)

商户处的用户ID

转账金额

amount

BigDecimal

100.00000000

转账金额,固定保留8位小数

矿工费

minerFee

BigDecimal

0.00001000

矿工费金额,固定保留8位小数

链代码

chain

String(30)

ETH

链代码,详细见 附件:链代码

代币符号

symbol

String(32)

USDT

代币符号,详细见 附件:代币符号

目标地址

toAddress

String(50)

收取加密货币的钱包地址

转账备注信息

transferDesc

Sting

订单状态

state

String(1)

2

支付订单状态 0-订单生成 1-支付中 2-支付成功 3-支付失败 4-已撤销 5-已退款 6-订单关闭

错误码

errCode

String

1002

渠道下单返回错误码

错误描述

errMsg

String

134586944573118714

渠道下单返回错误描述

扩展参数

extParam

String(512)

134586944573118714

商户扩展参数

创建时间

createdAt

String(13)

1622016572190

订单创建时间,13位时间戳

成功时间

successTime

String(13)

1622016572190

订单支付成功时间,13位时间戳

通知请求时间

reqTime

String(30)

1622016572190

通知请求时间,,13位时间戳

返回示例数据

{
    "code": 0,
    "data": {
        "amount": 1,
        "appId": "6113805e42020495c62bd4cb",
        "createdAt": 1628818820011,
        "chain": "ETH",
        "entryType": "WX_CASH",
        "errCode": "OPENID_ERROR",
        "errMsg": "openid与商户appid不匹配【openid与商户appid不匹配】",
        "mchNo": "M1623997351",
        "mchOrderNo": "1628818820",
        "minerFee": 0.00001000,
        "reqTime": "1622016572190",
        "state": 3,
        "symbol": "USDT",
        "transferDesc": "测试",
        "transferId": "T202108130940200100001",
        "toAddress": "0xBC8c393959e5d8f2C96B1D5a8262a6762747B98b",
    },
    "msg": "SUCCESS",
    "sign": "A262DBD3D6182E8A0AEC90EF820F2A5A"
}

Last updated