取现/代发类接口¶
bind01 绑定取现卡接口¶
功能说明¶
适用产品企账通/app+,用于个人用户或者企业用户绑卡取现卡。个人用户绑取现卡时,如果没有开过户,会自动开户。企业用户绑取现卡,必须先开户。解绑请调用银行卡解绑接口。
调用方式:后台返回(同步)
调用地址:
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 可选 | 由汇付生成,用户的唯一性标识 对公必填 |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长50位String | 必须 | |
用户姓名 | user_name | 变长50位String | 可选 | 用户客户号为空必填 当开户类型为2、3时必填 |
身份证 | id_card | 变长19位String | 可选 | 用户客户号为空必填 当开户类型为2、3时必填 |
手机号 | user_mobile | 变长11位String | 可选 | 用户客户号为空必填 |
银行代号 | bank_id | 变长8位String | 可选 | 对公必填 当开户类型为2、3时必填 |
支行名称 | branch_name | 变长128位String | 可选 | |
银行卡号 | card_num | 变长32位String | 必须 | |
绑卡类型 | card_type | 定长1位String | 必须 | 0:对公 1:对私 |
银行卡开户省份 | card_prov | 定长4位String | 可选 | 默认上海 |
银行卡开户地区 | card_area | 定长4位String | 可选 | 默认上海 |
默认取现卡标志 | default_cash_flag | 定长1位String | 可选 | 0:非默认取现卡 ;1:默认取现卡默认取现卡; 不传默认0 |
职业 | occupation | 定长2位String | 可选 | 01:机关、团体、企事业单位负责人 02:科学研究人员 03:工程技术人员 04:医生 05:经济和金融人员 06:法律、社会和宗教人员 07:”教师 08:新闻出版、文化专业人员 09:公务员 10:服务业 11:农、林、牧、渔业 12:制造业 13:军人 99:其他从业人员 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位String | 可选 | JSON格式串 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见一级返回码表 |
应答返回描述 | resp_desc | 变长String | 必须 | 一级返回码的对应中文描述 |
商户唯一标识号 | mer_cust_id | 定长16位 | 必须 | 由汇付生成,商户的唯一性标识 |
用户唯一标识号 | user_cust_id | 定长16位 | 必须 | 由汇付生成,用户的唯一性标识 |
用户账户号 | acct_id | 变长8位String | 可选 | |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长50位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 变长20位String | 可选 | 汇付生成唯一流水号 |
银行代号 | bank_id | 变长8位String | 可选 | 银行代号 |
银行卡号 | card_num_mask | 变长32位String | 必须 | 银行卡号掩码 |
绑定ID | bind_card_id | 变长20位String | 可选 | 取现接口需要用到此ID |
银行卡开户省份 | card_prov | 定长4位String | 可选 | |
银行卡开户地区 | card_area | 定长4位String | 可选 | |
开户类型 | reg_type | 定长1位String | 可选 | 1:汇付账户 2:银行账户 3:全部账户 |
用户角色 | user_role | 定长1位String | 可选 | 0:付款方 1:收款方 |
银行账户号 | bank_acct_virtual_num | 变长64位String | 可选 | 开银行账户时返回 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
unbd01 银行卡解绑接口¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 可选 | 由汇付生成,用户的唯一性标识 对公必填 |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长50位String | 必须 | |
绑卡ID | bind_card_id | 变长20位String | 必须 | |
银行卡类型 | card_buss_type | 定长1位String | 必须 | 0:取现卡 1:代扣卡 2:快捷卡 9:解绑所有 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位String | 可选 | JSON格式串 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功, C00001–请求处理中 其他见返回码表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户唯一标识号 | mer_cust_id | 定长16位 | 必须 | 由汇付生成,商户的唯一性标识 |
用户唯一标识号 | user_cust_id | 定长16位 | 必须 | 由汇付生成,用户的唯一性标识 |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长50位String | 必须 | |
银行卡绑定ID | bind_card_id | 变长20位String | 可选 | 取现接口需要用到此ID |
银行卡类型 | card_buss_type | 定长1位String | 可选 | 0:取现卡 1:代扣卡 2:快捷卡 9:解绑所有 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
本平台交易唯一标识号 | platform_seq_id | 变长20位String | 可选 |
cash01 取现(接口版)¶
功能说明¶
适用产品企账通/app+,从汇付账户取现到银行卡,支持商户,企业用户,个体工商户,个人取现。对公账户取现时间请控制在10:00:00-23:59:59范围内。
调用方式:后台返回(同步,异步)
调用地址:
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | 付款人汇付客户号 |
订单日期 | order_date | 定长8位String | 必须 | 格式为YYYYMMDD,例如:20160307 |
订单号 | order_id | 变长50位String | 必须 | 由商户生成,必须保证唯一, 50位内的字母或数字组合 |
交易金额 | trans_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
绑定ID | bind_card_id | 变长20位的String | 必须 | 取现绑卡后返回的绑卡ID |
出账账户号 | out_acct_id | 变长9位的String | 可选 | |
手续费收取子账户 | fee_acct_id | 变长9位的String | 可选 | 指定手续费收取方账户 和Fee_cust_id必须同时传入 |
手续费客户号 | fee_cust_id | 定长16位String | 可选 | 和fee_acct_id 必须同时传入 |
取现方式 | cash_type | 定长2位的String | 必须 | T0:T0取现; T1:T1取现 D1:D1取现 |
服务费金额 | serv_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费用户号 | serv_cust_id | 定长16位String | 可选 | 服务费收取方客户号(有服务费必填) |
服务费账户号 | serv_acct_id | 变长9位的String | 可选 | 服务费收取方账户号(有服务费必填) |
商户后台应答地址 | bg_ret_url | 变长128位的String | 可选 | 通过后台异步通知商户开户结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
概要 | summary | 变长32位的String | 可选 | |
备注 | remark | 变长200位的String | 可选 | |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位String | 必须 | json格式如:{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”};注:ipAddr和devType必填,MAC和IMEI 二选一必填,见下文 |
交易发生地 | transaction_addr | 定长64位String | 必填 | 例如:上海 |
用途 | purpose | 定长256位String | 必填 | 例如:其他 |
对手方ip | user_ip_addr | 定长20位String | 必填 | 用户终端ip |
设备静态信息:
字段 | 字段描述 | 是否必须 |
---|---|---|
devType | 设备类型 1.电脑;2.手机 | 必填 |
ipAddr | IP地址 | 必填 |
MAC | MAC地址 | 选填 |
IMEI | IMEI码 | 选填 |
devSysType | 设备系统类型 1.IOS;2.安卓;3.windows | 选填 |
UUID | UUID | 选填 |
IMSI | IMSI码 | 选填 |
ICCID | ICCID码 | 选填 |
MEID | MEID码 | 选填 |
SEID | SEID | 选填 |
ipType | IP地址类型代理、家庭、办公环境、网吧、学校等,直接给中文名称 | 选填 |
ipProvName | IP省 | 选填 |
ipCityName | IP市 | 选填 |
ipAreaName | IP地区 | 选填 |
ipProvCode | IP省编码 | 选填 |
ipCityCode | IP市编码 | 选填 |
ipAreaCode | IP地区编码 | 选填 |
cenX | 定位(经度) | 选填 |
cenY | 定位(纬度) | 选填 |
provName | 定位地址(省) | 选填 |
cityName | 定位地址(市) | 选填 |
areaName | 定位地址(区) | 选填 |
provCode | 定位(省编码) | 选填 |
cityCode | 定位(市编码) | 选填 |
areaCode | 定位(区编码) | 选填 |
unDevCode | 用户交易设备(唯一识别码) | 选填 |
serviceProviderIp | 商户服务IP地址 | 选填 |
merUrl | 商户网址 | 选填 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 变长16位的String | 必须 | |
用户客户号 | user_cust_id | 定长16位String | 必须 | 付款人汇付客户号 |
订单日期 | order_date | 定长8位String | 必须 | |
订单号 | order_id | 变长20位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 定长18位String | 必须 | 组成规则:8位本平台日期+ 10位系统流水号 |
交易金额 | trans_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
实际到账金额 | real_trans_amt | 变长14位的String | 可选 | 取现成功实际到账金额,各种原因导致取现失败则不传 |
取现绑卡ID | bind_card_id | 变长20位的String | 可选 | 卡号/取现绑卡ID二选一必填 |
出账账户号 | out_acct_id | 变长9位的String | 可选 | 出账账户号 |
开户银行代号 | bank_id | 变长8位的String | 可选 | 具体见附件:开户银行代号 |
手续费金额 | fee_amt | 变长14位的String | 必须 | |
手续费扣款客户号 | fee_cust_id | 变长16位的String | 可选 | |
手续费扣款子账户号 | fee_acct_id | 变长9位的String | 可选 | |
服务费 | serv_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费收取方客户号 | serv_cust_id | 变长16位的String | 可选 | |
手续费账户号 | serv_acct_id | 变长9位的String | 可选 | |
商户后台应答地址 | bg_ret_url | 变长128位的String | 可选 | 通过后台异步通知,商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串,表明商户已经收到该笔交易结果。 注意: 1) URL中请不要包含特殊字符 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
cash02 取现(页面版)¶
功能说明¶
适用产品企账通,从汇付账户取现到银行卡,调用后跳转支付密码输入页面。支持商户,企业用户,个体工商户,个人取现。对公账户取现时间请控制在10:00:00-23:59:59范围内。
调用方式:后台返回(同步,异步)
调用地址:
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | |
订单日期 | order_date | 定长8位String | 必须 | 格式为YYYYMMDD,例如:20160307 |
订单号 | order_id | 变长20位String | 必须 | 由商户生成,必须保证唯一, 20位内的字母或数字组合 |
交易金额 | trans_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
绑卡ID | bind_card_id | 变长20位的String | 必须 | 取现绑卡接口返回绑卡ID |
出账账户号 | out_acct_id | 变长9位的String | 可选 | 不传,从默认子账户取现 |
手续费收取子账户 | fee_acct_id | 变长9位的String | 可选 | 和fee_acct_id 必须同时传入 |
手续费收取客户号 | fee_cust_id | 变长16位String | 可选 | 和fee_cust_id 必须同时传入 |
取现方式 | cash_type | 定长2位的String | 必须 | T0:T0取现 T1:T1取现 D1:D1取现 |
服务费金额 | serv_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费用户号 | serv_cust_id | 定长16位String | 可选 | 服务费收取方客户号 |
服务费账户号 | serv_acct_id | 变长9位的String | 可选 | 服务费收取方账户号 |
前台返回地址 | ret_url | 变长128位的String | 可选 | |
商户后台应答地址 | bg_ret_url | 变长128位的String | 必须 | 通过后台异步通知商户开户结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
页面类型 | request_type | 变长2位String | 可选 | P:桌面端页面 M:移动端页面 默认P桌面端 |
概要 | summary | 变长32位的String | 可选 | |
备注 | remark | 变长200位的String | 可选 | |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位String | 必须 | json格式如:{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”};注:ipAddr和devType必填,MAC和IMEI 二选一必填,见下文 |
交易发生地 | transaction_addr | 定长64位String | 必填 | 例如:上海 |
用途 | purpose | 定长256位String | 必填 | 例如:其他 |
设备静态信息:
字段 | 字段描述 | 是否必须 |
---|---|---|
devType | 设备类型 1.电脑;2.手机 | 必填 |
ipAddr | IP地址 | 必填 |
MAC | MAC地址 | 选填 |
IMEI | IMEI码 | 选填 |
devSysType | 设备系统类型 1.IOS;2.安卓;3.windows | 选填 |
UUID | UUID | 选填 |
IMSI | IMSI码 | 选填 |
ICCID | ICCID码 | 选填 |
MEID | MEID码 | 选填 |
SEID | SEID | 选填 |
ipType | IP地址类型代理、家庭、办公环境、网吧、学校等,直接给中文名称 | 选填 |
ipProvName | IP省 | 选填 |
ipCityName | IP市 | 选填 |
ipAreaName | IP地区 | 选填 |
ipProvCode | IP省编码 | 选填 |
ipCityCode | IP市编码 | 选填 |
ipAreaCode | IP地区编码 | 选填 |
cenX | 定位(经度) | 选填 |
cenY | 定位(纬度) | 选填 |
provName | 定位地址(省) | 选填 |
cityName | 定位地址(市) | 选填 |
areaName | 定位地址(区) | 选填 |
provCode | 定位(省编码) | 选填 |
cityCode | 定位(市编码) | 选填 |
areaCode | 定位(区编码) | 选填 |
unDevCode | 用户交易设备(唯一识别码) | 选填 |
serviceProviderIp | 商户服务IP地址 | 选填 |
merUrl | 商户网址 | 选填 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | 调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 变长16位的String | 必须 | |
用户客户号 | user_cust_id | 定长16位String | 必须 | 付款人汇付客户号 |
订单日期 | order_date | 定长8位String | 必须 | |
订单号 | order_id | 变长20位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 定长18位String | 必须 | |
交易金额 | trans_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
实际到账金额 | real_trans_amt | 变长14位的String | 可选 | 取现成功实际到账金额,各种原因导致取现失败则不传 |
取现绑卡ID | bind_card_id | 变长20位的String | 可选 | 取现绑卡ID |
出账账户号 | out_acct_id | 变长9位String | ||
开户银行代号 | bank_id | 变长8位的String | 可选 | 具体见附件:开户银行代号 |
手续费金额 | fee_amt | 变长14位的String | 必须 | |
手续费扣款客户号 | fee_cust_id | 变长16位的String | 必须 | |
手续费扣款子账户号 | fee_acct_id | 变长9位的String | 可选 | |
服务费 | serv_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费收取方客户号 | serv_cust_id | 变长16位的String | ||
手续费账户号 | serv_acct_id | 变长9位的String | 可选 | |
前台返回地址 | ret_url | 变长128位的String | ||
商户后台应答地址 | bg_ret_url | 变长128位的String | 可选 | 通过后台异步通知,商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串,表明商户已经收到该笔交易结果。 注意: 1) URL中请不要包含特殊字符 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
cash05 众邦取现(接口版)¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
订单日期 | order_date | 定长8位String | 必须 | 格式为YYYYMMDD,例如:20160307 |
订单号 | order_id | 变长20位String | 必须 | 由商户生成,必须保证唯一, 20位内的字母或数字组合 |
交易金额 | trans_amt | 变长14位String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
银行虚拟账户 | bank_virtual_acct_num | 变长40位String | 必须 | 银行虚拟账户 |
商户后台应答地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户开户结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
备注 | remark | 变长200位String | 可选 | 备注 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | 调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 变长16位String | 必须 | |
订单日期 | order_date | 定长8位String | 必须 | |
订单号 | order_id | 变长20位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 定长18位String | 必须 | |
交易金额 | trans_amt | 变长14位String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
实际到账金额 | real_trans_amt | 变长14位String | 可选 | 取现成功实际到账金额,各种原因导致取现失败则不传 |
银行虚拟账户 | bank_virtual_acct_num | 变长40位String | 必须 | 银行虚拟账户 |
手续费金额 | fee_amt | 变长14位String | 必须 | |
商户后台应答地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知,商户应在应答接收的响应中输出RECV_ORD_ID字样的字符串,表明商户已经收到该笔交易结果。 注意: 1) URL中请不要包含特殊字符 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
cash06 取现代绑卡(页面版)¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户客户号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
用户客户号 | user_cust_id | 定长16位String | 必须 | |
订单日期 | order_date | 定长8位String | 必须 | 格式为YYYYMMDD,例如:20160307 |
订单号 | order_id | 变长20位String | 必须 | 由商户生成,必须保证唯一,20位内的字母或数字组合 |
交易金额 | trans_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
出账账户号 | out_acct_id | 变长9位的String | 可选 | 出账账户号,为空由用户页面选择 |
手续费收取子账户 | fee_acct_id | 变长9位的String | 可选 | 自定义手续费收取账户号,请保证该账户余额充足。和fee_cust_id 必须同时传入;若希望向用户收取,请使用fee_obj=”U”(手续费将从用户取现金额中扣除); |
手续费收取客户号 | fee_cust_id | 变长16位String | 可选 | 和fee_acct_id 必须同时传入 |
取现方式 | cash_type | 定长8位的String | 必须 | T0取现:T1取现 D1取现 |
服务费金额 | serv_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费用户号 | serv_cust_id | 定长16位String | 可选 | 服务费收取方客户号,服务费非空时必填 |
服务费账户号 | serv_acct_id | 变长9位的String | 可选 | 服务费收取方账户号,服务费非空时必填 |
前台返回地址 | ret_url | 变长128位的String | 可选 | |
商户后台应答地址 | bg_ret_url | 变长128位的String | 可选 | 通过后台异步通知商户开户结果。注意:1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位的String | 必须 | json格式。ipAddr和devType必填,MAC和IMEI 二选一必填,见下文 |
页面类型 | request_type | 变长2位的String | 可选 | P:桌面端 M:移动端 默认桌面端 |
概要 | summary | 变长32位的String | 可选 | |
备注 | remark | 变长200位的String | 可选 | |
手续费收取方 | fee_obj | 定长1位的String | 可选 | M:向商户收 U:向用户收 和fee_cust_id不能同时传入 |
交易发生地 | transaction_addr | 定长64位String | 必填 | 例如:上海 |
用途 | purpose | 定长256位String | 必填 | 例如:其他 |
设备静态信息:
字段 | 字段描述 | 是否必须 |
---|---|---|
devType | 设备类型 1.电脑;2.手机 | 必填 |
ipAddr | IP地址 | 必填 |
MAC | MAC地址 | 选填 |
IMEI | IMEI码 | 选填 |
devSysType | 设备系统类型 1.IOS;2.安卓;3.windows | 选填 |
UUID | UUID | 选填 |
IMSI | IMSI码 | 选填 |
ICCID | ICCID码 | 选填 |
MEID | MEID码 | 选填 |
SEID | SEID | 选填 |
ipType | IP地址类型代理、家庭、办公环境、网吧、学校等,直接给中文名称 | 选填 |
ipProvName | IP省 | 选填 |
ipCityName | IP市 | 选填 |
ipAreaName | IP地区 | 选填 |
ipProvCode | IP省编码 | 选填 |
ipCityCode | IP市编码 | 选填 |
ipAreaCode | IP地区编码 | 选填 |
cenX | 定位(经度) | 选填 |
cenY | 定位(纬度) | 选填 |
provName | 定位地址(省) | 选填 |
cityName | 定位地址(市) | 选填 |
areaName | 定位地址(区) | 选填 |
provCode | 定位(省编码) | 选填 |
cityCode | 定位(市编码) | 选填 |
areaCode | 定位(区编码) | 选填 |
unDevCode | 用户交易设备(唯一识别码) | 选填 |
serviceProviderIp | 商户服务IP地址 | 选填 |
merUrl | 商户网址 | 选填 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | 调用成功,其他见返回码附件表 |
应答返回描述 | resp_desc | 变长String | 必须 | 返回码的对应中文描述 |
商户客户号 | mer_cust_id | 变长16位的String | 必须 | |
用户客户号 | user_cust_id | 定长16位String | 必须 | 付款人汇付客户号 |
订单日期 | order_date | 定长8位String | 必须 | |
订单号 | order_id | 变长20位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 定长18位String | 必须 | |
交易金额 | trans_amt | 变长14位的String | 必须 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
实际到账金额 | real_trans_amt | 变长14位的String | 可选 | 取现成功实际到账金额,各种原因导致取现失败则不传 |
取现绑卡ID | bind_card_id | 变长20位的String | 必须 | 取现绑卡ID |
出账账户号 | out_acct_id | 变长9位String | ||
手续费金额 | fee_amt | 变长14位的String | 可选 | |
手续费扣款客户号 | fee_cust_id | 变长16位的String | 可选 | |
手续费扣款子账户号 | fee_acct_id | 变长9位的String | 可选 | |
服务费 | serv_amt | 变长14位的String | 可选 | 泛指交易金额,金额格式必须是###.00,比如2.00,2.01 |
服务费收取方客户号 | serv_cust_id | 变长16位的String | 可选 | |
手续费账户号 | serv_acct_id | 变长9位的String | 可选 | |
商户后台应答地址 | bg_ret_url | 变长128位的String | 必须 | 通过后台异步通知商户开户结果。注意:1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位的String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |
返回码¶
返回码 | 返回描述 |
---|---|
公共返回码 | |
A40083 | 不支持该业务 |
A50001 | 您尚未开通取现功能,请联系汇付业务人员。 |
A50004 | 取现金额小于单笔最小交易金额 |
A50005 | 取款后账户余额小于起结金 |
A50006 | T0取现金额超出单日限额 |
A50007 | 取现服务费超出取现金额 |
A50008 | 服务手续费收取失败 |
A50009 | 取现手续费未配置 |
A50010 | 账户余额不足 |
A50011 | 通道失败 |
A50012 | 过渡账户不能出账 |
A50013 | 商户取现不支持服务费 |
A50014 | 取现密码配置异常 |
A50015 | 取现短信配置异常 |
A50023 | 取现金额不正确 |
A50024 | 取现银行卡不存在 |
A50026 | 出账账户号不存在 |
A50027 | 手续费账户信息不正确 |
A50028 | 服务费账户信息不正确 |
fap001 代发¶
请求参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
版本号 | version | 定长2位String | 必须 | 目前固定为10 |
商户唯一标识号 | mer_cust_id | 定长16位String | 必须 | 由汇付生成,商户的唯一性标识 |
出账账号 | out_acct_id | 定长8位String | 必须 | 出款方账户号 |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长50位String | 必须 | |
收款银行账号 | card_num | 变长32位String | 必须 | |
收款账户类型 | card_type | 定长1位String | 必须 | 0:对公 1:对私 |
交易金额 | trans_amt | 变长14位String | 必须 | (金额格式必须是###.00)比如2.00,2.01 |
代发类型 | trans_mode | 变长2位String | 可选 | T0 : T0代发 T1:T1代发 默认T0 |
收款人姓名 | user_name | 变长50位String | 必填 | 必须与银行账号开户名称一致 |
证件号 | id_card | 变长19位String | 可选 | 对私必填 |
手机号 | mobile | 变长11位String | 可选 | 对私必填 |
银行代号 | bank_id | 变长8位String | 可选 | 对公必填,对私选填 |
手续费账户号 | fee_acct_id | 定长8位String | 可选 | |
支行名称 | branch_name | 变长128位String | 可选 | |
代发用途 | purpose | 变长256位String | 必须 | |
银行卡开户省份 | card_prov | 定长4位String | 可选 | 默认上海 |
银行卡开户地区 | card_area | 定长4位String | 可选 | 默认上海 |
后台返回地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户绑卡结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位String | 可选 | 用于扩展请求参数 |
设备静态信息 | dev_info_json | 变长2000位String | 必填 | json格式如:{“ipAddr”:”10.99.195.11”,”devType”:”2”,”MAC”:”D4-81-D7-F0-42-F8”,”IMEI”:”3553200846666033”};注:ipAddr和devType必填,MAC和IMEI 二选一必填,见下文 |
交易发生地 | transaction_addr | 定长64位String | 必填 | 例如:上海 |
用途 | purpose | 定长256位String | 必填 | 例如:其他 |
对手方ip | user_ip_addr | 定长20位String | 必填 | 用户终端ip |
设备静态信息:
字段 | 字段描述 | 是否必须 |
---|---|---|
devType | 设备类型 1.电脑;2.手机 | 必填 |
ipAddr | IP地址 | 必填 |
MAC | MAC地址 | 选填 |
IMEI | IMEI码 | 选填 |
devSysType | 设备系统类型 1.IOS;2.安卓;3.windows | 选填 |
UUID | UUID | 选填 |
IMSI | IMSI码 | 选填 |
ICCID | ICCID码 | 选填 |
MEID | MEID码 | 选填 |
SEID | SEID | 选填 |
ipType | IP地址类型代理、家庭、办公环境、网吧、学校等,直接给中文名称 | 选填 |
ipProvName | IP省 | 选填 |
ipCityName | IP市 | 选填 |
ipAreaName | IP地区 | 选填 |
ipProvCode | IP省编码 | 选填 |
ipCityCode | IP市编码 | 选填 |
ipAreaCode | IP地区编码 | 选填 |
cenX | 定位(经度) | 选填 |
cenY | 定位(纬度) | 选填 |
provName | 定位地址(省) | 选填 |
cityName | 定位地址(市) | 选填 |
areaName | 定位地址(区) | 选填 |
provCode | 定位(省编码) | 选填 |
cityCode | 定位(市编码) | 选填 |
areaCode | 定位(区编码) | 选填 |
unDevCode | 用户交易设备(唯一识别码) | 选填 |
serviceProviderIp | 商户服务IP地址 | 选填 |
merUrl | 商户网址 | 选填 |
返回参数¶
参数中文名称 | 参数名称 | 数据格式 | 是否必须 | 说明 |
---|---|---|---|---|
应答返回码 | resp_code | 定长6位String | 必须 | C00000–调用成功,其他见一级返回码表 |
应答返回描述 | resp_desc | 变长String | 必须 | 一级返回码的对应中文描述 |
商户唯一标识号 | mer_cust_id | 定长16位 | 必须 | 由汇付生成,商户的唯一性标识 |
出账账号 | out_acct_id | 定长8位String | 必须 | 出款方账户号 |
订单日期 | order_date | 定长8位String | 必须 | 格式为“yyyyMMdd” |
订单号 | order_id | 变长20位String | 必须 | |
本平台交易唯一标识号 | platform_seq_id | 变长20位String | 可选 | 汇付生成唯一流水号 |
交易金额 | trans_amt | 变长14位String | 必须 | (金额格式必须是###.00)比如2.00,2.01 |
手续子账户 | fee_acct_id | 定长8位String | 可选 | |
手续费金额 | fee_amt | 变长14位String | 可选 | |
后台返回地址 | bg_ret_url | 变长128位String | 必须 | 通过后台异步通知商户绑卡结果 注意: 1) 使用时不要包含中文 2) 必须是外网地址 |
商户私有域 | mer_priv | 变长120位String | 可选 | 为商户的自定义字段,该字段在交易完成后由本平台原样返回 |
扩展域 | extension | 变长512位的String | 可选 | 用于扩展请求参数 |