购买加密货币下单接口

统一下单

商户业务系统通过统一下单接口发起购买加密货币订单，BePay支付网关会根据商户配置的买币通道路由支付通道完成买币下单。

接口说明

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

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

请求方式：POST

请求类型：application/json 或 application/x-www-form-urlencoded

请求参数

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

商户号

mchNo

是

String(30)

M1621873433953

商户号

应用ID

appId

是

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

是

String(30)

20160427210604000490

商户生成的订单号

商户用户ID

mchUserId

是

String(32)

234562345

商户处的用户ID(唯一ID)

支付方式代码

payWayCode

是

String(32)

10001

支付方式代码，如Visa/Master Card对应代码10001,详细见【附件：支付方式代码】分页

加密货币购买配置ID

cryptoBuyConfigId

是

Long

1

购买加密货币配置列表接口获取

订单金额

amount

是

BigDecimal

100.00

订单金额（固定保留2位小数）

法币货币代码

fiatCurrency

是

String(3)

USD

法币查询接口获取支持的法币

加密货币代码

cryptoCurrency

是

String(12)

USDT

加密货币查询接口获取法币支持的加密货币

链代码

chain

是

String(30)

TRC

加密货币收单网络，如ETH/BSC/BTC

收款地址

address

是

String(64)

0xb602521615a15es0ds5

用户接收数字货币的地址

异步通知地址

notifyUrl

否

String(256)

https://www.bepay.one

支付结果异步回调URL,只有传了该值才会发起回调

跳转通知地址

returnUrl

否

String(256)

https://www.bepay.one

支付结果同步跳转通知URL

失效时间

expiredTime

否

int

3600

订单失效时间,单位秒,默认24小时.订单在(创建时间+失效时间)后失效

额外参数

channelExtra

否

String(256

{“auth_code”:“13920933111042”}

特定渠道发起的额外参数,json格式字符串.详见附件：支付额外参数

扩展参数

extParam

否

String(512)

134586944573118714

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

请求时间

reqTime

是

long

1622016572190

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

接口版本

version

是

String(3)

1.0

接口版本号，固定：1.0

签名

sign

是

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名值，详见签名算法

签名类型

signType

是

String(32)

MD5

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

请求示例数据

{
  "amount": 100.00,
  "extParam": "",
  "mchOrderNo": "mho1624005107281",
  "mchUserId": "234562345",
  "payWayCode": "10001",
  "cryptoBuyConfigId": 1,
  "sign": "84F606FA25A6EC4783BECC08D4FDC681",
  "reqTime": "1624005107",
  "version": "1.0",
  "channelExtra": "",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "notifyUrl": "https://www.bepay.one",
  "signType": "MD5",
  "fiatCurrency": "USD",
  "cryptoCurrency": "USDT",
  "chain": "TRC",
  "address": "0xb602521615a15es0ds5",
  "returnUrl": "",
  "mchNo": "M1623984572",
}

返回参数

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

返回状态

code

是

int

0

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

返回信息

msg

否

String(128)

签名失败

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

签名信息

sign

否

String(32)

CCD9083A6DAD9A2DA9F668C3D4517A84

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

返回数据

data

否

String(512)

{}

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

data数据格式

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

支付订单号

orderId

是

String(30)

B12021022311124442600

返回支付系统订单号

商户用户ID

mchUserId

是

String(30)

20160427210604000490

返回商户用户ID

商户订单号

mchOrderNo

是

String(30)

20160427210604000490

返回商户传入的订单号

订单金额

amount

是

BigDecimal

100.00

订单金额（固定保留2位小数）

加密货币购买手续费

cryptoBuyFeeAmount

是

BigDecimal

0.50

返回加密货币购买手续费

法币货币代码

fiatCurrency

是

String(3)

USD

返回法币货币代码

加密货币代码

cryptoCurrency

是

String(12)

USDT

返回加密货币代码

链代码

chain

是

String(30)

TRC

返回加密货币收单网络

收款地址

address

是

String(64)

0xb602521615a15es0ds5

返回用户收款地址

订单状态

state

是

int

2

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

支付数据类型

payDataType

是

String

payUrl

详见下方：payDataType说明

支付数据

payData

否

String

http://www.jeequan.com/pay.html

发起支付用到的支付参数

渠道错误码

errCode

否

String

ACQ.PAYMENT_AUTH_CODE_INVALID

上游渠道返回的错误码

渠道错误描述

errMsg

否

String

Business Failed 失败

上游渠道返回的错误描述

data数据数据中payDataType详细说明

payDataType
说明

payurl

跳转链接的方式

返回示例数据

{
  "code": 0,
  "data": {
    "errCode": "10005",
    "errMsg": "Invalid Request Parameters.",
    "mchOrderNo": "mho1624005752661",
    "orderState": 3,
    "orderId": "B202106181642329900002",
    "amount": 100.00,
    "cryptoBuyFeeAmount": 0.50,
    "fiatCurrency": "USD",
    "cryptoCurrency": "USDT",
    "chain": "TRC",
    "address": "0X15a15es0ds5"
  },
  "msg": "SUCCESS",
  "sign": "F4DA202C516D1F33A12F1E547C5004FD"
}

查询订单

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

接口说明

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

请求URL：https://{BePay Domain}/api/crypto/buy/orderQuery

请求方式：POST

请求类型：application/json 或 application/x-www-form-urlencoded

请求参数

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

商户号

mchNo

是

String(30)

M1621873433953

商户号

应用ID

appId

是

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

支付订单号

orderId

是

String(30)

B20160427210604000490

支付中心生成的订单号，与mchOrderNo二者传一即可

商户订单号

mchOrderNo

是

String(30)

20160427210604000490

商户生成的订单号，与payOrderId二者传一即可

请求时间

reqTime

是

long

1622016572190

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

接口版本

version

是

String(3)

1.0

接口版本号，固定：1.0

签名

sign

是

String(32)

C380BEC2BFD727A4B6845133519F3AD6

签名值，详见签名算法

签名类型

signType

是

String(32)

MD5

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

请求示例数据

{
  "orderId": "P202106181104177050002",
  "appId": "60cc09bce4b0f1c0b83761c9",
  "sign": "46940C58B2F3AE426B77A297ABF4D31E",
  "signType": "MD5",
  "reqTime": "1624006009",
  "mchNo": "M1623984572",
  "version": "1.0"
}

返回数据

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

返回状态

code

是

int

0

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

返回信息

msg

否

String(128)

签名失败

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

签名信息

sign

否

String(32)

CCD9083A6DAD9A2DA9F668C3D4517A84

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

返回数据

data

否

String(512)

{}

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

data数据格式

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

支付订单号

orderId

是

String(30)

P12021022311124442600

返回支付系统订单号

商户号

mchNo

是

String(30)

M1621873433953

商户号

应用ID

appId

是

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

是

String(30)

20160427210604000490

返回商户传入的订单号

支付方式代码

payWayCode

是

String(30)

10005

支付方式代码

支付金额

amount

是

BigDecimal

100

支付金额（保留2位小数）

法币货币代码

fiatCurrency

是

String(3)

USD

三位货币代码

加密货币代码

cryptoCurrency

是

String(12)

USDT

返回加密货币代码

链代码

chain

是

String(12)

TRC

返回加密货币收单网路

收款地址

address

是

String(64)

0x15a15es0ds5

返回用户收款地址

订单状态

state

是

int

2

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

渠道订单号

channelOrderNo

否

String

20160427210604000490

对应渠道的订单号

渠道错误码

errCode

否

String

1002

渠道下单返回错误码

渠道错误描述

errMsg

否

String

业务异常错误

渠道下单返回错误描述

扩展参数

extParam

否

String(512)

134586944573118714

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

创建时间

createdAt

是

long

1622016572190

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

成功时间

successTime

否

long

1622016572190

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

返回示例数据

{
  "code": 0,
  "data": {
    "cryptoBuyConfigId": 1,
    "defaultFeeSymbol": "USDT",
    "amount": 58.00,
    "cryptoBuyFeeAmount": 0.5,
    "appId": "60cc09bce4b0f1c0b83761c9",
    "channelOrderNo": "2021061822001423031419593035",
    "createdAt": 1623985457705,
    "fiatCurrency": "USD",
    "cryptoCurrency": "USDT",
    "chain": "TRC",
    "address": "0X15a15es0ds5",
    "ifCode": "Ramp",
    "extParam": "",
    "mchNo": "M1623984572",
    "mchOrderNo": "mho1623985457320",
    "mchUserId": "123456",
    "orderId": "B202106181104177050002",
    "state": 2,
    "successTime": 1623985459000,
    "payWayCode": "10005"
  },
  "msg": "SUCCESS",
  "sign": "9548145EA12D0CD8C1628BCF44E19E0D"
}

支付通知

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

接口说明

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

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

请求方式：POST

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

通知参数

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

支付订单号

orderId

是

String(30)

P12021022311124442600

返回支付系统订单号

商户号

mchNo

是

String(30)

M1621873433953

商户号

应用ID

appId

是

String(24)

60cc09bce4b0f1c0b83761c9

应用ID

商户订单号

mchOrderNo

是

String(30)

20160427210604000490

返回商户传入的订单号

支付方式代码

payWayCode

是

String(30)

10005

支付方式代码

支付金额

amount

是

BigDecimal

100

支付金额（保留2位小数）

法币货币代码

fiatCurrency

是

String(3)

USD

三位货币代码

加密货币代码

cryptoCurrency

是

String(12)

USDT

返回加密货币代码

链代码

chain

是

String(12)

TRC

返回加密货币收单网路

收款地址

address

是

String(64)

0x15a15es0ds5

返回用户收款地址

订单状态

state

是

int

2

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

渠道订单号

channelOrderNo

否

String

20160427210604000490

对应渠道的订单号

渠道错误码

errCode

否

String

1002

渠道下单返回错误码

渠道错误描述

errMsg

否

String

业务异常错误

渠道下单返回错误描述

扩展参数

extParam

否

String(512)

134586944573118714

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

创建时间

createdAt

是

long

1622016572190

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

成功时间

successTime

否

long

1622016572190

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

> 返回结果

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

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

通知示例数据

{
    "cryptoBuyConfigId": 1,
    "defaultFeeSymbol": "USDT",
    "amount": 58.00,
    "cryptoBuyFeeAmount": 0.5,
    "appId": "60cc09bce4b0f1c0b83761c9",
    "channelOrderNo": "2021061822001423031419593035",
    "createdAt": 1623985457705,
    "fiatCurrency": "USD",
    "cryptoCurrency": "USDT",
    "chain": "TRC",
    "address": "0X15a15es0ds5",
    "ifCode": "Ramp",
    "extParam": "",
    "mchNo": "M1623984572",
    "mchOrderNo": "mho1623985457320",
    "mchUserId": "123456",
    "orderId": "B202106181104177050002",
    "state": 2,
    "successTime": 1623985459000,
    "payWayCode": "10005"
  }

Previous价格查询Next附件：支付方式代码

Last updated