代扣支付接口

本API为后台接口,上送代扣绑卡id进行代扣扣款。

涉及到的接口包括: 线上交易查询接口 、 线上交易退款接口、 线上退款查询接口。

请求参数

  • 请求地址

https://spin.cloudpnr.com/top-online-ser/withholdpay

  • 公共请求参数

请求报文头HEADER - 「接口规则-参数规定-报文头」 ,请求报文体BODY - 「接口规则-参数规定-报文体」 ,响应报文体 - 「接口规则-参数规定-响应报文体」

  • 请求参数(data)
参数中文名称 参数名称 数据格式 是否必须 说明
请求流水号 req_seq_id 变长64位String 必须  
请求日期 req_date 定长8位String 必须 请求时间YYYYMMDD
产品号 product_id 变长32位String 必须  
商户号 huifu_id 变长32位String 必须  
用户号 user_huifu_id 变长32位String 必须  
绑卡ID card_bind_id 变长32位String 必须 绑卡ID
订单金额 trans_amt 变长12位String 必须 订单金额,单位元,需保留小数点后两位,例如:1.00,最低传入0.01
异步通知地址 mer_notice_url 变长512位String 必须 virgo://#{http_server_url} 例:virgo://http://www.xxx.com/getResp
延时标记 is_delay_acct 固定1位String 可选 是否延时交易,1为延迟 0为不延迟
订单有效期 time_expire 固定14位String 可选 订单失效时间 YYYYMMDDHHMMSS格式
商户私有域 mer_priv 变长1024位String 可选  
分账串 acct_split_bunch JSON 可选 请求分账串
设备信息 device_info String 必须 设备信息
网联扩展信息 nacl_info String 必须 网联扩展信息
风控信息 risk_check_info 变长4000位String 必须 jsonstring, 风控信息

设备信息

参数 中文名 类型 必填 最大长度 说明
trx_device_type 设备类型 String Y 2 01:手机,02:平板,03:手表,04:PC
trx_device_ip 交易设备IP String Y 45 用于标识交易设备IP地址,目前暂传IPv4格式
trx_device_mac 交易设备MAC String N 12 去掉特殊的连接符号,如冒号、连接符
trx_device_imei 交易设备IMEI String N 15  
trx_device_imsi 交易设备IMSI String N 15  
trx_device_icc_id 交易设备ICCID String N 20  
trx_device_wifi_mac 交易设备WIFIMAC String N 12  
trx_device_gps 交易设备GPS String N 23  

网联扩展信息

参数 中文名 类型 必填 最大长度 说明
goods_short_name 商品简称 String Y 40 不能包含特殊字符
biz_tp 业务种类 String Y 6 业务种类

响应参数

  • 同步失败响应参数(resp_data)

仅传business_url且校验失败场景返回

sub_resp_code 返回码 String Y 8 业务返回码
sub_resp_desc 返回描述 String Y 512 业务返回描述
req_seq_id 请求流水号 String Y 64  
req_date 请求日期 String Y 8  
hf_seq_id 汇付流水号 String N 128  
product_id 产品号 String Y 32  
huifu_id 商户号 String Y 32  
user_huifu_id 用户号 String N 32  
bank_id 银行代号 String N 8  
debit_flag 借贷标识 String N 1 D-借记,C-贷记卡
trans_amt 交易金额 String N 12  
mer_priv 商户私有域 String N 1024  
  • 异步响应参数(resp_data)
参数 中文名 类型 必填 最大长度 说明
sub_resp_code 返回码 String Y 8 业务返回码
sub_resp_desc 返回描述 String Y 512 业务返回描述
req_seq_id 请求流水号 String Y 64  
req_date 请求日期 String Y 8  
product_id 产品号 String Y 32  
huifu_id 商户号 String Y 32  
user_huifu_id 用户号 String N 32  
bank_id 银行代号 String N 8  
debit_flag 借贷标识 String N 1 D-借记,C-贷记卡
trans_amt 交易金额 String N 12  
fee_amt 手续费 String N 12  
is_delay_acct 是否延时分账 String N 1 0:实时;1:延时
is_div 是否分账交易 String N 1 0:非分账交易;1:是分账交易
fee_flag 手续费扣款标志 String N 1 1:外扣;2:内扣
trans_stat 交易状态 String N 1 I:处理中,P:处理中,S:成功,F:失败
acct_stat 账务状态 String N 1 I:处理中,P:处理中,S:成功,F:失败
channel_code 通道返回码 String N 8  
channel_message 通道返回描述 String N 128  
trans_type 交易类型 String Y   交易类型
mer_priv 商户私有域 String N 1024  
acct_split_bunch 分账串 JSON N   返回分账串

交易类型

transType 备注
WITHHOLD_PAY 代扣支付

请求示例

java

{
    "data":"{\"req_seq_id\":\"20210708121117821122\",\"req_date\":\"20210708\",\"product_id\":\"JCTEST\",\"huifu_id\":\"6666000103423237\",\"user_huifu_id\":\"6666000103423833\",\"card_bind_id\":\"10000067314\",\"trans_amt\":\"1.02\",\"is_delay_acct\":\"0\",\"mer_notice_url\":\"http://www.baidu.com\",\"time_expire\":\"\",\"mer_priv\":\"\",\"nacl_info\":{\"goods_short_name\":\"01\",\"biz_tp\":\"123451\"},\"device_info\":{\"trx_device_type\":\"01\",\"trx_device_ip\":\"127.0.0.1\"},\"risk_check_info\":{\"riskMngInfo\":{\"subTradeType\":\"4300\"}}}",
    "sign":"gAtdfftq6WjJQNnMODgly9a21n4Uv3cRb6lLg9QytBhYlE9mOet4QceKG2UnY36NWxPKKNFcABrCKt1/rVCJWwYrXOC9V7lVNpnl0oI3POb9L9ePtxsqpudjzTKQTbq8ypSuAa41QLltnEPH/V2Y7sK5UuXoSSOZ/0xFyjbvrXkjXQ6cr9dLbgzCk6F9bUaW0fzRKdnAiMcD+8rkDJ6BqA2nBdSweFJ5w+UfABUG2XZprKp2PBgnt8FxpBe4NqVvkhwDaTohEO6kcLN/lrif9bqEb+KyMuePI0pD7GXHkFe2Ied9CV3hn6aKTTG7nFG1Al9lNq/xKNdEzAlB45dOGA==",
    "signType":"RSA2",
    "sysId":"JCTEST"
}

响应示例

java

{
    "data":"{\"acct_id\":\"C00091082\",\"bagent_id\":\"6666000003078903\",\"bagent_name\":\"上海集成企业\",\"bank_id\":\"01030000\",\"bank_name\":\"\",\"card_bind_id\":\"10000067314\",\"cash_resp_code\":\"00000000\",\"cash_resp_desc\":\"成功\",\"client_ip\":\"127.0.0.1\",\"db_unit\":\"1\",\"device_info\":\"{\\\"trx_device_ip\\\":\\\"127.0.0.1\\\",\\\"trx_device_type\\\":\\\"01\\\"}\",\"fee_flag\":\"2\",\"fee_rec_type\":\"1\",\"goods_desc\":\"01\",\"hf_seq_id\":\"0047default210708164740P141c0a855d100000\",\"huifu_id\":\"6666000103423237\",\"is_acct_div\":\"0\",\"is_acct_div_param\":\"0\",\"is_delay_acct\":\"0\",\"license_code\":\"110101199003074290\",\"license_type\":\"01\",\"limit_acct_type\":\"D\",\"mer_id\":\"SSP001\",\"mer_name\":\"盈盈超市\",\"mer_priv\":\"\",\"merchant_info_b_o\":{\"huifu_id\":\"6666000103423237\",\"license_code\":\"\",\"mcc\":\"\",\"mer_name\":\"盈盈超市\",\"mer_short_name\":\"盈盈超市\",\"mer_type\":\"01\",\"pa_mer_id\":\"SSP001\",\"product_id\":\"JCTEST\",\"receipt_name\":\"盈盈超市\",\"reg_name\":\"\",\"sub_mer_id_cipher\":\"#011NG6f4K9trR1BKPTFSdSkllasgdDfTBPf\",\"sub_mer_id_mask\":\"110************290\",\"sub_mer_id_tp\":\"00\",\"up_bagent_id\":\"6666000003078903\",\"up_bagent_name\":\"上海集成企业\"},\"nacl_info\":\"{\\\"biz_tp\\\":\\\"123451\\\",\\\"goods_short_name\\\":\\\"01\\\"}\",\"ord_amt\":\"1.02\",\"ord_id\":\"20210708164740defaultL2129080896\",\"order_type\":\"P\",\"pay_card_id\":\"622848*********9979\",\"pay_card_id_enc\":\"#011Ag/Gqi3FVPJNuDtJdmiQIc/RZtEll0cd\",\"pegasus\":false,\"product_id\":\"JCTEST\",\"region_id\":\"default\",\"req_date\":\"20210708\",\"req_seq_id\":\"20210708121117821122\",\"risk_check_info\":\"{\\\"riskMngInfo\\\":{\\\"subTradeType\\\":\\\"4300\\\"}}\",\"sub_resp_code\":\"00000100\",\"sub_resp_desc\":\"交易正在处理中\",\"sys_id\":\"JCTEST\",\"time_expire\":\"\",\"trans_notify_url\":\"http://www.baidu.com\",\"trans_stat\":\"P\",\"trans_type\":\"WITHHOLD_PAY\",\"trx_device_type\":\"01\",\"user_huifu_id\":\"6666000103423833\",\"user_name\":\"张三李四啊\",\"version\":\"1.0.0\"}",
    "resp_code":"10000",
    "resp_desc":"成功调用",
    "sign":"gDk883KapbJ79i8jOz/2axse1FXwwd6A6UGCEBWTNYLVekP8dCMC+JSS46LKBMoNENwDMKxSxEbSpWJT36NO/DSXJKZ0qdNJ8nHZd4Qj6WeY30mnbozOYm1npbyij8WJ6LQZ8Wih9vNQpuX3RJj9gvHs0Ag+DUkRXqS3/Y3L864JstE3wl1Rc3gmLrb3a5JUtwPxL5smYGcSDt/QbZME89y/vtrAveTgn3YT7FOVi0a1Ip6MwVaNbrEJwLmJDYJHSNj4aC7P4UPMvlNVr+B9y1ODp+BQAkr4zHGpxg6hhTPjOzS5ep5PcA5Uld+P5KHXPRhIWGRTWZJ+9PqJ5JU6Tg=="
}

接口调用示例

Demo参考