主题
支付下单
接口描述
供医院HIS系统进行支付调用,仅进行支付动作,不进行患者账户余额操作。
请求URL
/his/order/pay
请求方式
- POST
公共请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| appId | 是 | string | 应用ID,甬易提供,一个固定的值 | 202415629590370906 | |
| signature | 是 | string | 签名 | ||
| transNonce | 是 | string | 32 | 请求流水号 | 43e2c287-24b1-4cd1-b3d2-e40e7840cc40 |
| transDate | 是 | string | 13 | 请求时间,13位时间戳 | 1731406784607 |
请求参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| outTradeNo | 是 | string | 32 | 订单号,商户平台侧订单号 | ORDER_001 |
| tradeAmount | 是 | string | 20 | 支付金额,单位分 | 10000 |
| tradeSubject | 是 | string | 255 | 订单主题 | 苹果手机 |
| notifyUrl | 是 | string | 255 | 异步通知URL | https://example.com/notify |
| returnUrl | 否 | string | 255 | 支付成功后返回URL | https://example.com/return |
| remark | 否 | string | 255 | 备注 | 挂号费 |
| payerIp | 否 | string | 32 | 客户IP地址 | 192.168.1.1 |
| expireTime | 是 | string | 过期时间 | 2026-04-23 18:00:00 | |
| wxAppId | 否 | string | 微信AppId,交易支持使用商户自己的wxAppId | wx1234567890 | |
| openId | 否 | string | 微信用户openId,交易支持使用商户自己的wxAppId | o1234567890 | |
| authCode | 否 | string | 用户付款码授权码。付款码场景该字段必填(设备扫码获取的授权码);扫脸支付场景该值为商户平台唤起扫脸采集和认证后获取到的ftoken | 288912345678901234 | |
| terminalNo | 否 | string | 用户终端号,付款码场景该字段必填 | T001 | |
| payProduct | 是 | string | 支付产品:JSAPI-jsapi支付 APP-app支付 H5-h5支付 NATIVE-native支付 MICROPAY-付款码支付 FACE-扫脸支付 | JSAPI | |
| payBrand | 是 | string | 支付品牌:ALI_MINI_PROGRAM-支付宝小程序 ALI_APP-支付宝App ALI_LIFE-支付宝生活号 WX_MINI_PROGRAM-微信小程序 WX_OFFICIAL_ACCOUNT-微信公众号 WX_APP-微信App | WX_MINI_PROGRAM | |
| longitude | 否 | string | 经度 | 116.407425 | |
| latitude | 否 | string | 纬度 | 39.90425 |
请求报文示例
json
{
"appId": "202415629590370906",
"signature": "pz+Z8unqO2VBjTGtzWASCCfzix5QxODSkAdKKyPiVXIXLtp574xCmuWaOeHfslnbUK2RKsYdNy/OhcMPV+GMaoXxcXuDvmVhUdKHWgYODovK5GbbqfqaT+nrzO0xnNz8rLCnevTQ3y4+Qn6++xVlwyMOW3SDw9gRM5qF40TlectpvylieoFROXzYIHXBveRrcT3FQSwnoNamNet/k7OTvotiT0Fft6SGDflqkWeHhiP83265OSMvQPwtIcEStyTv4AHLsWC5pSd7zTQ+pkvetMlm0AAwO6Jl4xUYx+OZkBM8vpgxqAQa4yzV9mTwfsaFZsKRnTXTJdFVHr9xONro5g==",
"transDate": "1731469621597",
"transNonce": "43e2c287-24b1-4cd1-b3d2-e40e7840cc40",
"outTradeNo": "ORDER_001",
"tradeAmount": 100.00,
"tradeSubject": "医院挂号",
"notifyUrl": "https://example.com/notify",
"returnUrl": "https://example.com/return",
"remark": "挂号费",
"payerIp": "192.168.1.1",
"expireTime": "2026-04-23 18:00:00",
"wxAppId": "wx1234567890",
"openId": "o1234567890",
"authCode": "",
"terminalNo": "",
"payProduct": "JSAPI",
"payBrand": "WX_MINI_PROGRAM",
"longitude": "116.407425",
"latitude": "39.90425"
}公共响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| code | 是 | string | 响应编码:000000000-成功,非000000000-失败,具体原因取message | 00000000 | |
| message | 是 | string | 响应信息 | 成功 | |
| signature | 是 | string | 签名 | ||
| transNonce | 是 | string | 32 | 请求流水号(同入参) | 43e2c287-24b1-4cd1-b3d2-e40e7840cc40 |
| transDate | 是 | string | 13 | 响应时间,13位时间戳 | 1731406784607 |
响应参数
| 参数名 | 必选 | 类型 | 最大长度 | 说明 | 示例 |
|---|---|---|---|---|---|
| outTradeNo | 是 | string | 32 | 医院侧订单号,同入参outTradeNo | ORDER_001 |
| tradeNo | 是 | string | 32 | 甬易订单号 | XS20260423000001 |
| qrCode | 否 | string | 二维码URL,扫码支付场景必须返回 | https://pay.xspay.com/qr/xxx | |
| payInfo | 否 | string | 支付参数信息,公众号、小程序、生活号等JSAPI方式返回的支付参数,用于唤起App | ||
| bankId | 是 | string | BankId | B001 |
响应示例
json
{
"code": "00000000",
"message": "成功",
"signature": "pz+Z8unqO2VBjTGtzWASCCfzix5QxODSkAdKKyPiVXIXLtp574xCmuWaOeHfslnbUK2RKsYdNy/OhcMPV+GMaoXxcXuDvmVhUdKHWgYODovK5GbbqfqaT+nrzO0xnNz8rLCnevTQ3y4+Qn6++xVlwyMOW3SDw9gRM5qF40TlectpvylieoFROXzYIHXBveRrcT3FQSwnoNamNet/k7OTvotiT0Fft6SGDflqkWeHhiP83265OSMvQPwtIcEStyTv4AHLsWC5pSd7zTQ+pkvetMlm0AAwO6Jl4xUYx+OZkBM8vpgxqAQa4yzV9mTwfsaFZsKRnTXTJdFVHr9xONro5g==",
"transDate": "1731469621597",
"transNonce": "43e2c287-24b1-4cd1-b3d2-e40e7840cc40",
"outTradeNo": "ORDER_001",
"tradeNo": "XS20260423000001",
"qrCode": "",
"payInfo": "",
"bankId": "B001"
}备注
- 更多返回错误代码请看 通用规则说明-错误码 的错误代码描述