杰易汇提交接口

功能描述

商户通过此接口提交杰易汇数据。

接口地址

https://apis.geoswift.com/remittance/order

参数名称	参数中文名称	类型& 长度	参数说明	是否必填
merchantId	商户编号	varchar(9)	商户在汇元通系统的唯一id，可在商户后台查看	M
requestId	订单号	varchar(50)	订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一。汇元通系统成功或取消的订单，商户平台不能以相同的订单号再次提交。	M
requestCreditedAmount	请求到账金额（CNY）	varchar(18)	以分为单位（与汇入金额参数，只可且必须传其中一个参数）	C
amount	汇入金额	varchar(18)	以分为单位（如：1 元=100，与请求到账金额参数，只可且必须传其中一个参数）	C
currency	汇入金额币种	固定值	EUR 欧元	M
			GBP 英镑
			CAD 加元
			SGD 新加坡元
			AUD 澳元
			JPY 日元
			USD 美元
			HKD 港币
			CNH 离岸人民币
notifyUrl	通知地址	varchar(200)	交易终态后汇元通会向该地址发送通知，该地址可以带参数，“https://www.geoswift.com/callback.action?test=test注意：如不填notifyUrl的参数值交易成功后您的服务器将得不到交易成功的通知。	O
tradePostscript	汇款附言	varchar(256)	汇款附言	O
sourceCountry	资金来源国	char(3)	资金来源国，三位英文编码，见编码表	M
payee	收款人信息	Json	收款人信息，见下表
payer	付款人信息	Json	付款人信息，见下表
fundPurpose	资金用途	固定值	以下支持全币种，收款人为中国大陆居民：	M
			SALARY 工资
			FAMILY_FUND 赡家款
			OTHER 个人红包
			以下支持 CNY，收款人为非中国大陆居民：
			STUDYING_ABROAD 留学费及生活费
			TRAINING_ABROAD 培训费及生活费
			SIGHTSEEING 观光
			BUSINESS_TRAVEL 商务旅行
			MEDICAL_ABROAD 医疗
			HKMT 港澳台居民同人汇款
payeeAccount	收款账户信息	Json	收款账户信息，见下表
partnerId	服务商 id	varchar(9)	二级商户上属服务商商户在汇元通系统的唯一身份标识（如果发起商户自身即为主商户此项可不传）	C
partnerCommissionFeeType	返佣计费模式	固定值	FIXED 单笔	C
			PERCENT 百分比
			partnerCommissionFeeValue不为空时该字段必传
			传递partnerid时可传此参数
partnerCommissionFeeValue	返佣计费内容	varchar(10)	若是按笔收取，传200，则表示每笔收2元佣金	C
			若是按百分比收取，传15，则表示按到账金额的0.15%收取佣金
			eg.汇款金额10000USD，服务商签约费率0.2%，佣金传的0.15%，那么该笔汇款的手续费为：100000.2%+100000.15%=35，其中15美金会定期结算到服务商资金账户。
			partnerCommissionFeeType不为空时该字段必传
			传递partnerid时可传此参数
hmac	参数签名	varchar(500)	商户生成的参数签名结果，获取hmac的方法请参考请求加密流程	M

以上参数值中不能包含以下特殊字符’”&<>()

请求参数（payee，收款人信息）

参数名称	参数中文名称	类型& 长度	参数说明	是否必填
name	收款人姓名	varchar(50)	收款人姓名拼音（name与nameZh优先都需要传，若只传一个，请提前咨询技术支持）	C
nameZh	收款人姓名（中文）	varchar(50)	中文收款人姓名（name与nameZh优先都需要传，若只传一个，请提前咨询技术支持）	C
payeeBirthday	收款人生日	varchar(8)	收款人生日，格式：yyyyMMdd	O
swiftCode	收款人银行swift编号	varchar(11)	收款人银行swift编号	O
idType	收款人证件类型	固定值	01 身份证	M
			03 护照
			05 其他证件类型
idNum	收款人证件号	varchar(18)	证件号	M
phoneNum	收款人手机号	varchar(11)	收款人手机号	O
bankCardNum	银行卡号	varchar(19)	银行卡号，目前支持收款银行请见"编码表"->"BIN表"->"下载"，收款账户类型为银行卡时，银行卡号必填	C
bankName	银行名称	varchar(100)	银行名称	O
bankAddress	银行地址	varchar(100)	银行地址	O
bankCity	银行所在市	varchar(50)	银行所在市	O
payeeIdEffectDateStart	收款人证件生效日期	varchar(8)	收款人证件生效日期，格式：yyyyMMdd	O
payeeIdEffectDateEnd	收款人证件失效日期	varchar(8)	收款人证件失效日期，格式：yyyyMMdd	O
payeeAddress	收款人详细地址	varchar(200)	收款人详细地址	M
payeeAreaCode	收款人地区编码	varchar(50)	收款人地区编码，按区号3级代码，如没有3级代码，则传2级代码，见编码表	O
payeeProfessionCode	收款人职业编码	varchar(50)	收款人职业编码，按职业3级代码，见编码表	O
payeeGender	收款人性别	固定值	MALE 男	O
payeeGender	收款人性别	固定值	FEMALE 女	O
firstName	收款人名	varchar(32)	收款人名，传英文或拼音	O
lastName	收款人姓	varchar(32)	收款人姓，传英文或拼音	O

请求参数（payer，付款人信息）

参数名称	参数中文名称	类型& 长度	参数说明	是否必填
name	付款人姓名	varchar(50)	传拼音或英文。实际汇款个人姓名，不可为公司名称	M
idType	付款人证件类型	固定值	01 身份证（全币种）	M
			02 中国护照（汇款币种为 CNH）
			03 护照（汇款币种非 CNH）
			04 海外护照（汇款币种为 CNH）
			05 其他证件类型（全币种）
			06 台湾居民来往内地通行证（汇款币种为 CNH）
			07 港澳居民来往内地通行证（汇款币种为 CNH）
idNum	付款人证件号	varchar(18)	证件号	M
bankCardNum	付款人账户	varchar(19)	资金来源的付款人账户号、银行卡。若为现金，则可传付款人在机构注册的用户ID号	M
payerCountry	付款人国籍	char(3)	付款人国家编码，三位英文编码	M
address	付款人所在地址	varchar(100)	付款人居住地址，精确到街道	M
birthday	付款人生日	varchar(50)	付款人生日，格式：yyyy-MM-dd	O
swiftCode	付款银行swift编号	varchar(11)	付款人银行swift编号	O
bankName	银行名称	varchar(100)	银行名称	O
bankAddress	银行地址	varchar(100)	银行地址	O
bankCity	银行所在市	varchar(50)	银行所在市	O
firstName	付款人名	varchar(32)	付款人名，传英文或拼音	O
lastName	付款人姓	varchar(32)	付款人姓，传英文或拼音	O
payerCity	付款人居住城市	varchar(40)	付款人居住城市	M
payerNameZh	付款人中文姓名	varchar(50)	付款人中文姓名资金用途为“HKMT”时，必传	C
payerGender	付款人性别	固定值	MALE 男	O
payerGender	付款人性别	固定值	FEMALE 女	O

请求参数（payeeAccount，收款账户信息）

参数名称	参数中文名称	类型& 长度	参数说明	是否必填
accountType	收款账户类型	固定值	WALLET_ACCOUNT 钱包账户	O
			BANK_CARD 银行卡
			不传默认银行卡
organCode	收款机构编码	varchar(50)	收款账户类型为钱包账户时传 000636	O
organCode	收款机构编码	varchar(50)	收款账户类型为银行卡时传 000000	O
walletAccountNo	钱包账号	varchar(64)	收款人支付宝账号收款帐户类型为钱包账户时，钱包账号必填	C

参数示例

{ "merchantId":"G90008001", "requestId":"1684398240023", "amount":20, "currency":"USD", "notifyUrl":"https://open.geoswift.com/notify.php", "tradePostscript":"", "sourceCountry":"USA", "payee":{ "name":"fengqixiang", "nameZh":"冯启祥", "payeeBirthday":"20000908", "swiftCode":"", "idType":"01", "idNum":"210***6779", "phoneNum":"", "bankCardNum":"622***0002", "bankName":"", "bankAddress":"", "bankCity":"", "payeeIdEffectDateStart":"", "payeeIdEffectDateEnd":"", "payeeAddress":"", "payeeAreaCode":"", "payeeGender":"MALE", "payeeProfessionCode":"", "firstName":"", "lastName":"" }, "payer":{ "name":"LIHAITAO", "idType":"01", "idNum":"411***3216", "bankCardNum":"310***6597", "payerCountry":"CHN", "address":"Delaware Dover 15", "birthday":"2000-12-08", "swiftCode":"", "bankName":"", "bankAddress":"", "bankCity":"", "firstName":"", "lastName":"", "payerCity":"New York", "payerNameZh":"张三", "payerGender":"MALE" }, "fundPurpose":"SALARY", "hmac":"akF950jUkDlbYjJn93rpe95eZ9wLjyr......VDkfwCSg2jrM2R5HIFyg313iv8SK3dw==", }

请求同步返回参数列表

参数名称	参数中文名称	参数说明
merchantId	商户编号	同请求参数
requestId	订单号	同请求参数
serialNumber	交易流水号	汇元通系统生成的唯一标识号
amount	金额	分为单位，1元=100分
requestCreditedAmount	请求到账金额（CNY）	同请求参数
payerCountry	资金来源国	资金来源国，见编码表.xlsx
currency	下单币种	同请求参数
tradePostscript	附言	汇款附言
status	请求状态	SUCCESS 发起成功(不代表交易成功，只能说明请求成功提交至汇元通系统)
		ERROR请求数据或者请求后系统流程出现问题，根据返回错误进行检查数据或者联系汇元通
		FAILED请求失败需要联系汇元通确认失败原因
businessStatus	业务状态	INIT待处理
		PROCESSING打款中
		FAILED打款失败
		SUCCESS打款成功
feeAmount	手续费金额	分为单位，1元=100分
feeCurrency	手续费币种	例：USD
creditedAmount	实际到账金额	分为单位，1元=100分
creditedCurrency	实际到账币种	CNY人民币
rate	牌价	牌价
completeDateTime	完成时间	例：2020-09-23 17:26:38
errorMsg	错误信息	错误信息
partnerId	服务商 id	同请求参数
partnerCommissionFeeType	返佣计费模式	同请求参数 partnerId不为空时返回
partnerCommissionFeeValue	返佣计费内容	同请求参数 partnerId不为空时返回
partnerCommissionAmount	返佣金额	单位为分,不会为小数 partnerId不为空时返回
hmac	参数签名	汇元通生成的参数签名结果，验签过程请参考解密流程

示例

{ "merchantId":"G10000014", "requestId":"1600853181782", "serialNumber":"2c9777f774afdb6b0174ba4912ee000c", "amount":"8700", "requestCreditedAmount": "", "payerCountry":"AF", "currency":"USD", "tradePostscript":"", "status":"SUCCESS", "businessStatus":"SUCCESS", "feeAmount":"870", "feeCurrency":"USD", "creditedAmount":"55320", "creditedCurrency":"CNY", "rate":"68065191", "completeDateTime":"2020-09-23 17:26:38", "hmac":"ifEdXNhRe......ICbJLAXGBEVw==" }

汇款异步返回参数列表

参数名称	参数中文名称	参数说明
merchantId	商户编号	同请求参数
requestId	订单号	同请求参数
serialNumber	交易流水号	汇元通系统生成的唯一标识号
amount	金额	分为单位，1元=100分
requestCreditedAmount	请求到账金额（CNY）	同请求参数
payerCountry	资金来源国	资金来源国，见编码表.xlsx
currency	下单币种	同请求参数
tradePostscript	附言	汇款附言
businessStatus	业务状态	FAILED 打款失败
		SUCCESS 打款成功
		CANCEL 打款取消
feeAmount	手续费金额	分为单位，1元=100分
feeCurrency	手续费币种	例：USD
creditedAmount	实际到账金额	分为单位，1元=100分
creditedCurrency	实际到账币种	CNY人民币
rate	牌价	牌价
completeDateTime	完成时间	例：2020-09-23 17:26:38
errorMsg	错误信息	错误信息
partnerId	服务商 id	同请求参数
partnerCommissionFeeType	返佣计费模式	同请求参数
partnerCommissionFeeValue	返佣计费内容	同请求参数
partnerCommissionAmount	返佣金额	单位为分,不会为小数
hmac	参数签名	汇元通生成的参数签名结果，验签过程请参考解密流程

示例

{ "merchantId":"G10000014", "requestId":"1600853181782", "serialNumber":"2c9777f774afdb6b0174ba4912ee000c", "amount":"8700", "requestCreditedAmount": "", "payerCountry":"AF", "currency":"USD", "tradePostscript":"", "businessStatus":"SUCCESS", "feeAmount":"870", "feeCurrency":"USD", "creditedAmount":"55320", "creditedCurrency":"CNY", "rate":"68065191", "completeDateTime":"2020-09-23 17:26:38", hmac":"ifEdXNhReYv.....vuICbJLAXGBEVw==" }