Skip to content

业务交易接口

本章节描述商户接入金运通快捷支付平台相关业务接口。

支付请求TD1004

使用说明

用户输入支付要素后下单,把信息送到金运通快捷支付平台,平台把用户信息送到银行端验证并在后台留存用户信息,验证成功后,并发送了短信就会返回状态” 平台处理中”,否则返回”支付失败”。【验证成功后,要做验证支付,调用TD4005接口】

交易代码

TD1004

使用时机

用户支付时,交易信息鉴权。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.订单号orderIdVARCHAR (32)M商户订单号(全局唯一)
2.银行卡号bankCardNoVARCHAR(30)M银行卡号。支持及限额详见 “快捷支付限额
3.身份证号idCardNoVARCHAR(30)M身份证号
4.手机号mobileVARCHAR(13)M手机号
5.姓名nameVARCHAR(30)M必须与持卡人在银行预留手机号一致
6.交易金额tranAmtNUMBER(15,2)M交易金额,以元为单位
7.银行编号bankCodeVARCHAR(8)O银行卡对应的银行编码。
为空时,由系统按卡规则设值
不为空时,取值见“银行编码”。
8.信用卡有效期expiredDateVARCHAR(4)O信用卡的有效期,格式为MMYY(月月年年),如0116
当为02信用卡时必输,
其他卡时,去掉这项
9.信用卡校验码cvv2VARCHAR(3)O与信用卡有效期共生,表示卡背面后3位数字
当为02信用卡时必输,
其他卡时,去掉这项
10.银行卡类型bankCardTypeVARCHAR(2)O卡类型:01借记卡,02信用卡;为空时,由系统按卡规则设值
11.通知地址notifyUrlVARCHAR(256)O用于交易最终结果通知地址,如果使用查询可不不填

响应字段

序号字段名称Json字段标签类型属性取值说明
1.验证状态tranStateVARCHAR (2)M① 当报文头的响应码为S0000000时有值,01平台处理中(短信发送成功)
② 当报文头的响应码为其它时,无报文体并表示下单失败
2.备注信息remarkVARCHAR(60)O验证结果说明

注:只有报文头的respCode为S0000000时才存在报文体【验证码有效时间4分钟】

支付验证TD4005

使用说明

支付请求鉴权后,将返回的支付鉴权码和订单号一起发到金运通支付平台确认支付。金运通平台将实时返回结果,最终结果:支付成功或支付失败;若非最终态,订单为银行处理中,说明渠道已受理;订单为平台处理中,说明渠道未受理(校验没有通过)。

交易代码

TD4005

使用时机

鉴权成功且商户短信校验成功后调用该接口做支付(验证支付)。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.订单号orderIdVARCHAR(32)M待支付订单号(全局唯一)
2.短信验证码verifyCodeVARCHAR(6)M持卡人收到的短信验证码

响应字段

序号字段名称Json字段标签类型属性取值说明
1.支付状态tranStateVARCHAR(2)M【00】支付成功
【01】平台处理中
【02】银行处理中
【03】支付失败
2.订单号orderIdVARCHAR(32)M支付订单号
3.交易金额tranAmountNUMBER(15,2)O支付金额(交易终态时,返回)
4.可退款金额avlAmountNUMBER(15,2)O可退款金额(交易终态时,返回)
5.交易时间tranDateVARCHAR(14)O商户交易开始时间,格式为
YYYYMMDDHHmmSS(交易终态时,返回)
6.备注信息remarkVARCHAR(60)O结果说明
7.手续费feeAmtNUMBER(15,2)O返回交易扣取的手续费

注:对于处理中02的交易,在平台确定其最终结果(支付成功<00>或支付失败<03>)后,将会向商户回调地址发送交易结果报文,报文格式与本次报文相同;商户回调地址由商户提供给金运通运营人员,运营人员为商户开通快捷支付业务时配置或交易上传。

实时返回交易失败时,没有报文体,通过报文头的respCode和respDesc判断错误原因

支付分账请求TD1007

使用说明

用户输入支付要素后下单,把信息送到金运通快捷支付平台,平台把用户信息送到银行端验证并在后台留存用户信息,验证成功后,并发送了短信就会返回状态” 平台处理中”,否则返回”支付失败”。【验证成功后,要做验证支付,调用TD4008接口】

交易代码

TD1007

使用时机

用户支付时,交易信息鉴权。

请求字段

序号
字段名称
Json字段标签类型属性取值说明
1.订单号orderIdVARCHAR (32)M商户订单号(全局唯一)
2.银行卡号bankCardNoVARCHAR(30)M银行卡号。支持及限额详见 “快捷支付限额
3.身份证号idCardNoVARCHAR(30)M身份证号
4.手机号mobileVARCHAR(13)M手机号
5.姓名nameVARCHAR(30)M必须与持卡人在银行预留手机号一致
6.交易金额tranAmtNUMBER(15,2)M交易金额,以元为单位
7.银行编号bankCodeVARCHAR(8)O银行卡对应的银行编码
8.信用卡有效期expiredDateVARCHAR(4)O信用卡的有效期,格式为MMYY(月月年年),如0116
当为02信用卡时必输,
其他卡时,去掉这项
9.信用卡校验码cvv2VARCHAR(3)O与信用卡有效期共生,表示卡背面后3位数字
当为02信用卡时必输,
其他卡时,去掉这项
10.银行卡类型bankCardTypeVARCHAR(2)O卡类型:01借记卡,02信用卡;为空时,由系统按卡规则设值
11.通知地址notifyUrlVARCHAR(256)O用于交易最终结果通知地址,如果使用查询可不不填
12.分账商户金额splitAmtNUMBER(15,2)O有值时,表示商户分账交易如果分账会员信息也有值,优先走会员分账
注:商户分账和会员分账必须一个有值
13.分账商户号splitMerchantNoVARCHAR(12)O商户分账交易时,可上传特定值。如果为空,则默认是合作方商户号
14.分账会员信息splitInfoVARCHAR(512)O有值时,表示会员分账交易:json字符串格式。
如json格式数组:[{"splitMemberAmt":"10","splitMemberNo":"Z00001"},{"splitMemberAmt":"50","splitMemberNo":"ZC0001"}]
注:商户分账和会员分账必须一个有值。
-分账会员编号splitMemberNoVARCHAR(32)C对应“会员编号”。如无,可先开通“会员注册
-分账金额splitMemberAmtNUMBER(15,2)C分给会员的金额

响应字段

序号字段名称Json字段标签类型属性取值说明
1.验证状态tranStateVARCHAR (2)M① 当报文头的响应码为S0000000时有值,01平台处理中(短信发送成功)
② 当报文头的响应码为其它时,无报文体并表示下单失败
2.备注信息remarkVARCHAR(60)O验证结果说明

注:只有报文头的respCode为S0000000时才存在报文体【验证码有效时间4分钟】

支付分账验证TD4008

使用说明

支付请求鉴权后,将返回的支付鉴权码和订单号一起发到金运通支付平台确认支付。金运通平台将实时返回结果,最终结果:支付成功或支付失败;若非最终态,订单为银行处理中,说明渠道已受理;订单为平台处理中,说明渠道未受理(校验没有通过)。

交易代码

TD4005

使用时机

鉴权成功且商户短信校验成功后调用该接口做支付(验证支付)。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.订单号orderIdVARCHAR(32)M待支付订单号(全局唯一)
2.短信验证码verifyCodeVARCHAR(6)M持卡人收到的短信验证码

响应字段

序号字段名称Json字段标签类型属性取值说明
1.支付状态tranStateVARCHAR(2)M【00】支付成功
【01】平台处理中
【02】银行处理中
【03】支付失败
2.订单号orderIdVARCHAR(32)M支付订单号
3.交易金额tranAmountNUMBER(15,2)O支付金额(交易终态时,返回)
4.可退款金额avlAmountNUMBER(15,2)O可退款金额(交易终态时,返回)
5.交易时间tranDateVARCHAR(14)O商户交易开始时间,格式为
YYYYMMDDHHmmSS(交易终态时,返回)
6.备注信息remarkVARCHAR(60)O结果说明
7.手续费feeAmtNUMBER(15,2)O返回交易扣取的手续费

注:对于处理中02的交易,在平台确定其最终结果(支付成功<00>或支付失败<03>)后,将会向商户回调地址发送交易结果报文,报文格式与本次报文相同;商户回调地址由商户提供给金运通运营人员,运营人员为商户开通快捷支付业务时配置或交易上传。

实时返回交易失败时,没有报文体,通过报文头的respCode和respDesc判断错误原因

签约请求TD1005

使用说明

用户输入四要素信息,把信息送到金运通快捷支付平台,平台把用户信息送到银行端验证并在后台留存用户信息,验证成功后发送手机动态验证码到用户手机,返回状态”银行验证成功(验证码已发送)”并返回绑卡订单号。

交易代码

TD1005

使用时机

用户只进行签约,不支付时使用。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.订单号orderIdCHAR(32)M商户订单号
2.银行卡号bankCardNoCHAR(30)M持卡人银行卡号
3.证件号idCardNoCHAR(30)M持卡人证件号
4.证件类型idCardTypeCHAR(2)O如果不输入,则默认为身份证
01:身份证
5.手机号mobileCHAR(13)M持卡人在银行预留的手机号
6.姓名nameCHAR(30)M必须与持卡人在银行预留手机号一致
7.有效期expiredDateCHAR(4)O信用卡的有效期,格式为MMYY(月月年年),如0116;
当为02信用卡时必输,
其他卡时,去掉这项
8.卡校验码cvv2CHAR(3)O与信用卡有效期共生,表示卡背面后3位数字。
当为02信用卡时必输,
其他卡时,去掉这项
9.银行编码bankCodeCHAR(8)O卡号所属银行编码
10.银行卡类型bankCardTypeCHAR(2)O【01】借记卡
【02】信用卡
为空时,由系统按卡规则设值

响应字段

序号字段名称Json字段标签类型属性取值说明
1.绑卡编号bindOrderIdChar(32)O当响应码为S0000000时有值。
签约确认时,需要将该字段传回平台

签约确认TD4006

使用说明

用户收到验证码后,填写验证码提交给商户,商户提交验证码到平台;平台验证通过后,表明持卡人已经签约成功,随意可以交易。

交易代码

TD4006

使用时机

调用接口TD1005后用户收到平台发送的验证码时。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.手机号mobileCHAR(13)O用户手机号,默认可不填
2.验证码verifyCodeCHAR(6)M短信验证码
3.绑卡编号bindOrderIdCHAR(32)MTD1005返回的绑卡编号

响应字段

无,根据报文头respCode判断,S0000000绑卡成功,其他绑卡失败!

协议支付TD4007

使用说明

签约(TD1005+TD4006)成功后,才能走此接口;接口模式:无需发短信,可以直接支付。

交易代码

TD4007

使用时机

支付签约成功后。

请求字段

序号
字段名称
Json字段标签类型属性取值说明
1.订单号orderIdCHAR(32)M商户订单号
2.银行卡号bankCardNoCHAR(30)M与绑定的卡号要一致
3.交易金额tranAmtNUMBER(15,2)M支付的金额
4.有效期expiredDateCHAR(4)O信用卡的有效期,格式为MMYY(月月年年),如0116;
当为02信用卡时必输,
其他卡时,去掉这项
5.卡校验码cvv2CHAR(3)O与信用卡有效期共生,表示卡背面后3位数字。
当为02信用卡时必输,
其他卡时,去掉这项
6.预留字段reqReserveCHAR(500)O请求预留字段
7.银行卡类型bankCardTypeCHAR(2)O01:借记卡
02:信用卡
为空时,由系统按卡规则设值
8.通知地址notifyUrlVARCHAR(256)O用于交易最终结果通知地址,如果使用查询可不不填
9.分账商户金额splitAmtNUMBER(15,2)O有值时,表示商户分账交易如果分账会员信息也有值,优先走会员分账)。
注:商户分账和会员分账为空时,表示非分账交易
10.分账商户号splitMerchantNoVARCHAR(12)O商户分账交易时,可上传特定值。如果为空,则默认是合作方商户号
11.分账会员信息splitInfoVARCHAR(512)O有值时,表示会员分账交易:json字符串格式。
如json格式数组:[{"splitMemberAmt":"10","splitMemberNo":"Z00001"},{"splitMemberAmt":"50","splitMemberNo":"ZC0001"}]
注:商户分账和会员分账为空时,表示非分账交易
-分账会员编号splitMemberNoVARCHAR(32)C对应“会员编号”。如无,可先开通“会员注册
-分账金额splitMemberAmtNUMBER(15,2)C分给会员的金额

响应字段

序号字段名称Json字段标签类型属性取值说明
1.支付状态tranStateVARCHAR (2)M【00】支付成功
【01】平台处理中
【02】银行处理中
【03】支付失败
2.订单号orderIdVARCHAR (32)M支付订单号
3.交易金额tranAmountNUMBER(15,2)O支付金额(交易终态时,返回)
4.可退款金额avlAmountNUMBER(15,2)O可退款金额(交易终态时,返回)
5.交易时间tranDateVARCHAR (14)O商户交易开始时间,格式为
YYYYMMDDHHmmSS(交易终态时,返回)
6.备注信息remarkVARCHAR (60)O结果说明
7.手续费feeAmtNUMBER(15,2)O返回交易扣取的手续费

注:对于处理中02的交易,在平台确定其最终结果(支付成功<00>或支付失败<03>)后,将会向商户回调地址发送交易结果报文,报文格式与本次报文相同;商户回调地址由商户提供给金运通运营人员,运营人员为商户开通实名快捷支付业务时配置或交易上传。

实时返回交易失败时,没有报文体,通过报文头的respCode和respDesc判断错误原因

支付退款TD1003

使用说明

用户支付成功后未收到支付成功应答,用户向商户提起申请,商户向平台提起申请,平台通过支付通道将金额返回到用户(也可通过商户端平台人工退款)。

交易代码

TD1003

使用时机

用户提起退款申诉时使用。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.商户订单号orderIdVARCHAR (32)M退款订单号
2.原订支付单号oriOrderIdVARCHAR (32)M原交易商户订单号
3.退款金额refundAmtNUMBER(15,2)M申请退款的金额

响应字段

序号字段名称Json字段标签类型属性取值说明
1.交易状态tranStateVARCHAR (2)M【01】申请成功
【05】退款成功
【06】退款处理中
【07】退款失败
【08】退款超限额
2.退款订单号orderIdVARCHAR (32)M退款订单号
3.交易时间merTranDateTimeVARCHAR (14)M商户申请退款的交易时间
YYYYMMDDHHmmSS
4.退款金额tranAmtNUMBER(15,2)M退款金额
5.可用余额avlAmountNUMBER(15,2)O可用余额
6.备注信息remarkVARCHAR(255)O结果说明

签约解除TD4002

使用说明

  1. 用户向商户发起解绑请求,商户向平台发起解绑请求,平台给出解绑响应。
  2. 用户银行存留手机号变更,需要把之前账号解绑,重新绑定新手机号才能进行交易。

交易代码

TD4002

使用时机

商户发起解除实名快捷支付已绑定银行卡请求

请求字段

序号字段名称Json字段标签类型属性取值说明
1.银行卡号bankCardNoVARCHAR(30)M银行卡号

响应字段

序号字段名称Json字段标签类型属性取值说明
1.交易状态tranStateVARCHAR(1)M解卡验证结果
0 通过
1 拒绝
2.备注remarkVARCHAR(255)O返回描述信息

重发短信TD4003

使用说明

商户未收到验证码或上次验证码已超时,重新向平台获取验证码(必须在5分钟之内)。

交易代码

TD4003

使用时机

商户未收到验证码或上次验证码已超时。

请求字段

序号字段名称Json字段标签类型属性取值说明
1.手机号mobileCHAR(13)M用户手机号
2.订单号orderIdCHAR(32)M商户待支付订单号

响应字段

序号字段名称Json字段标签类型属性取值说明
1.验证状态tranStateChar(2)M当响应码为S0000000(其它值时,均属于获取失败)时有值。
【01】订单信息验证成功(验证码已发送)
【02】重新获取验证码失败
【03】订单已过期(无法重新获取短信)
2.备注信息remarkChar(60)O结果说明

单笔支付查询TD2001

使用说明

用户支付成功后未收到支付成功应答,用户向商户提起查询申请,商户向平台提起单笔交易查询申请,平台给出结果

交易代码

TD2001

使用时机

商户发起单笔交易查询

请求字段

序号字段名称Json字段标签类型属性取值说明
1.订单号orderIdVARCHAR(32)M商户交易订单号

响应字段

序号字段名称Json字段标签类型属性取值说明
1.交易状态tranStateVARCHAR(2)M当响应码为S0000000时有值。
【00】支付成功
【01】平台处理中(未验证支付)
【02】银行处理中(已验证支付)
【03】支付失败
2.订单号orderIdVARCHAR(32)M商户订单号
3.交易时间merTranTimeVARCHAR(10)M商户发起交易的时间
YYYYMMDDHHmmSS
4.交易金额tranAmountNUMBER(15,2)M交易金额
5.可退款金额avlAmountNUMBER(15,2)O可退款金额
6.备注信息remarkVARCHAR(60)O结果说明
7.交易响应码tranRespCodeVARCHAR(8)M交易响应码
8.交易响应描述tranRespDescVARCHAR(50)O交易响应描述
9.手续费feeAmtNUMBER(15,2)O返回交易扣取的手续费

客户绑卡查询TD2002

使用说明

商户向平台发起查询申请,平台给出客户已绑定的卡列表详情

交易代码

TD2002

使用时机

商户发起绑卡信息查询

请求字段

序号字段名称Json字段标签属性取值说明
1.证件号certNoO证件号(暂时不支持)
2.银行卡号bankCardNoO银行卡号(二选一,优先填)

响应字段

序号字段名称Json字段标签属性取值说明
1.卡张数cardNumM
2.卡信息cardInfos[cardInfo]O当绑定了卡信息时,此信息必输

卡信息明细[cardInfo]

序号字段名称Json字段标签属性取值说明
1.银行卡号bankCardNoO
2.手机号phoneNoO
3.银行编号bankCodeO
4.银行名称bankNameO
5.卡类型bankCardTypeO【01】借记卡,【02】信用卡

退款交易查询TD2003

使用说明

用户向商户发起查询退款交易请求,查询退款状态。

交易代码

TD2003

使用时机

用户向商户发起退款查询动作

请求字段

序号字段名称Json字段标签类型属性取值说明
1.商户订单号orderIdVARCHAR (32)M商户退款订单号

响应字段

序号字段名称Json字段标签类型属性取值说明
1.交易状态tranStateVARCHAR(2)M【01】申请成功
【02】商户端拒绝申请
【03】商户端同意申请
【04】内管系统拒绝申请
【05】退款成功
【06】退款处理中
【07】退款失败
【08】退款超限额
2.商户订单号merTranFlowNoVARCHAR(32)M退款流水表:商户交易流水
3.商户退款交易时间merTranDateTimeVARCHAR(14)M商户申请退款时间
YYYYMMDDHHmmSS
4.退款金额refundAmtNUMBER(16,2)M退款的金额
5.退款银行号bankNoVARCHAR(30)O银行号
6.备注remarkVARCHAR(255)O备注

绑卡状态查询TD2004

使用说明

商户通过接口查看客户银行卡绑卡状态。

交易代码

TD2004

使用时机

判断用户是否已经绑卡

请求字段

序号字段名称Json字段标签类型属性取值说明
1.银行卡号bankCardNoCHAR(30)M持卡人的卡号

响应字段

序号字段名称Json字段标签类型属性取值说明
1.绑卡状态bindStateCHAR(4)M绑卡状态
【00】已绑定
【01】未绑卡(含已解绑)

交易结果异步通知

使用说明

对实名支付状态是最终态的结果通知给商户,【支付失败03】和【支付成功00】才会通知商户。注:商户接收此通知请求,(响应报文信息以请求字段中的响应信息为准)

交易代码

使用时机

调用接口TD4005支付成功或失败后,触发通知,处理中时,会通过定时任务跑交易,触发通知和上面一样【支付失败03】和【支付成功00】才会通知

请求字段

序号字段名称Json字段标签类型属性取值说明
1.交易状态tranStateCHAR(2)M【00】支付成功
【03】支付失败
2.订单号orderIdCHAR(32)M商户订单号
3.交易金额tranAmtCHAR(20)M交易金额
4.剩余金额avlAmountCHAR(20)M这笔订单剩余可退款金额
5.商户交易日期tranDateCHAR(14)M格式
yyyyMMddHHmmss
6.备注remarkCHAR(200)O描述交易,可选字段
7.手续费feeAmtCHAR (20)O返回交易扣取的手续费

响应字段

第一种返回信息:merchant_id=商户&msg_enc=报文密文&key_enc=会话密钥密文&sign=报文签名&mer_order_id=商户订单号(响应头的tranFlowid必须填请求头的tranFlowid)

第二种返回信息:不需要返回响应信息,即返回空字符串””或不返回

注:(第一种)商户响应报文头中respCode=S0000000时,表示正常接收处理报文。否则平台认为商户没有收到通知,继续发送通知,最多发送6次。(通知时间间隔:1,3,5,15,30,60; 单位:分钟)