将钱汇至指定银行账户或移动钱包
接口字段传值推荐使用英文
https://api.geoswift.com/ofr/remitOrder/create
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| merchantId | 商户编号 | varchar(9) | merchantId是由商家生成的ID。这个ID对于每个商家都是唯一的，可以用来确保请求的唯一性。如果该ID之前被使用过, 系统将响应"order already exists" | M |
| requestId | 订单号 | varchar(50) | 订单号为商户自行拟定，提交的订单号必须在自身平台交易中唯一。汇元通系统成功或取消的订单，商户平台不能以相同的订单号再次提交。 | M |
| remitPurpose | 汇款目的 | - | WAGE （工资） | M |
| FAMILY_MAINTENANCE （赡家汇款） | ||||
| PAYMENT_SERVICES （支付服务） | ||||
| GOODS （商品） | ||||
| EDUCATION_FEE （学费） | ||||
| OTHER （其他） | ||||
| PERSONAL_TRANSFER （个人转账） | ||||
| RENT（租金） | ||||
| ELEC（公共缴费） | ||||
| TAX（税费） | ||||
| SOFTWARE（软件服务） | ||||
| AD（广告服务） | ||||
| COMMISSION（佣金） | ||||
| quotationId | 牌价ID | varchar(32) | 由牌价创建或查询接口返回的serialNumber的参数值 | C |
| originalCountry | 源汇款国家代码 | - | 源汇款国家代码 | M |
| targetAmount | 目标汇款金额 | long(18) | 目标汇款金额;单位:分(中国), 1元=100分; 如果没有quotationId, targetAmount是必填字段 | C |
| targetCurrency | 目标币种 | - | 目标汇款币种，见“币种列表” | C |
| notifyUrl | 通知地址 | varchar(200) | 交易终态后(SUCCESS,FAILED,REVERSED,CANCELED)汇元通会向该地址发送通知(发送机制请参考"接口规则"板块),该地址可以带参数, “https://www.geoswift.com/callback.action?test=test 注意: 如不填notifyUrl的参数值, 交易成功后, 您的服务器将得不到交易成功的通知 | O |
| postscript | 汇款附言 | varchar(200) | 汇款附言 | O |
| remark | 汇款备注 | varchar(200) | 汇款备注 | O |
| extraRemark | 额外汇款备注 | varchar(200) | 额外汇款备注 | O |
| payer | 付款人信息 | JSON(array) | 付款人信息，见下表 | C |
| payee | 收款人信息 | JSON(array) | 收款人信息，见下表 | C |
| payeeAccount | 收款人账号 | JSON(array) | 收款人账号信息，见下表 | M |
| proveFiles | 证明文件 | JSON(array) | 收证明文件信息,最多3个文件，文件大小不超过8M | O |
| partnerId | 服务商编号 | varchar(9) | 二级商户上属服务商商户在汇元通系统的唯一身份标识（如果发起商户自身即为主商户此项可不传） | C |
| partnerCommissionFeeType | 返佣计费模式 | 固定值 | FIXED固定金额 | C |
| PERCENT百分比 | ||||
| partnerCommissionFeeValue字段不为空时，partnerCommissionFeeType字段必传 | ||||
| 传递partnerid时可传此参数 | ||||
| 目标币种是USD、AUD、GBP、CAD、SGD、JPY、EUR、HKD、CNH，需要包含手续费的时候，且服务商要收返佣金额时必传，否则按不收取返佣处理 | ||||
| 创建报价接口如上传此参数，则需与创建报价接口上传内容保持一致 | ||||
| partnerCommissionFeeValue | 返佣计费内容 | varchar(10) | 若是按笔收取，传200，则表示每笔收2元佣金 | C |
| 若是按百分比收取，传15，则表示按到账金额的0.15%收取佣金eg.汇款金额10000USD，服务商签约费率0.2%，佣金传的0.15%， 那么该笔汇款的手续费为：10000*0.2%+10000*0.15%=35，其中15美金回定期结算到服务商资金账户。 | ||||
| partnerCommissionFeeType字段不为空时，partnerCommissionFeeValue字段必传 | ||||
| 传递partnerid时可传此参数 | ||||
| 目标币种是USD、AUD、GBP、CAD、SGD、JPY、EUR、HKD、CNH，需要包含手续费的时候，且服务商要收返佣金额时必传，否则按不收取返佣处理 | ||||
| 创建报价接口如上传此参数，则需与创建报价接口上传内容保持一致 | ||||
| hmac | 参数签名 | varchar(500) | 商户生成的参数签名结果，获取hmac的方法请参考请求加密流程 | M |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| payerType | 付款人类型 | - | 如果不填取字段quotationId，则payerType为必填字段 | C |
| INDIVIDUAL 个人 | ||||
| COMPANY 公司 | ||||
| lastName | 付款人姓 | varchar(100) | 付款人姓（付款方是个人时，lastname+firstname或fullname至少传一组） | C |
| middleName | 中名 | varchar(100) | 中名（名和姓之间的名字） | O |
| firstName | 付款人的名 | varchar(100) | 付款人的名（付款方是个人时，lastname+firstname或fullname至少传一组） | C |
| fullName | 付款人全名 | varchar(100) | 付款人在本国语言中的全名（付款方是个人时，lastname+firstname或fullname至少传一组） | C |
| companyName | 付款人公司名称 | varchar(100) | 付款人公司名称（付款方是公司时，必传） | C |
| companyRegistCerNo | 公司注册证书号码 | varchar(50) | 公司注册证书号码 (IDTYPE为REGISTCER时必填) | C |
| taxNo | 公司税号 | varchar(50) | 公司税号 (IDTYPE为TAX时必填) | C |
| companyRegistDate | 公司注册日期 | - | 公司注册日期；名称格式:yyyymmdd | O |
| companyRegistCountry | 公司注册国家 | varchar(3) | 公司注册国家 | O |
| birthday | 付款人生日 | - | 付款人生日; 格式:yyyymmdd | O |
| birthCountry | 出生国代码 | - | 付款人出生国代码 | O |
| country | 付款人国家代码 | - | 付款人国家代码 | M |
| province | 付款人所在省 | varchar(20) | 付款人所在省 | O |
| city | 付款人所在城市 | varchar(50) | 付款人所在城市 | M |
| address | 付款人地址 | varchar(255) | 付款人地址 | M |
| postcode | 邮政编码 | varchar(50) | 付款人的邮政编码 | O |
| gender | 付款人性别 | - | MALE 男 | O |
| FEMALE 女 | ||||
| phoneNumber | 付款人电话号码 | varchar(50) | 付款人电话号码 | O |
| 付款人邮箱 | varchar(100) | 付款人邮箱 | O | |
| idType | 付款人ID类型 | - | IDCARD 身份证 | M |
| PASSPORT 护照 | ||||
| REGISTCER（注册登记证） | ||||
| TAX（税务登记证） | ||||
| OTHER 其他 | ||||
| idNo | ID号码 | varchar(50) | 指定ID类型下的ID号; 当payerType为INDIVIDUAL时idNo为必填项 | C |
| idEffectDateStart | ID的有效日期 | - | ID的有效日期; 格式为:yyyymmdd | O |
| idEffectDateEnd | ID失效日期 | - | ID失效日期; 格式为:yyyymmdd | O |
| profession | 付款人职业 | varchar(50) | 付款人的职业 | O |
| bankName | 银行名称 | varchar(100) | 付款人的银行名称 | O |
| bankCardNumber | 银行卡号 | varchar(50) | 银行卡号 | M |
| payeeRelation | 与收款人的关系 | - | SELF 自己 | O |
| FATHER 父亲 | ||||
| MOTHER 母亲 | ||||
| SON 儿子 | ||||
| DAUGHTER 女儿 | ||||
| BROTHER 兄弟 | ||||
| SISTER 姐妹 | ||||
| GRANDFATHER 爷爷/姥爷 | ||||
| GRANDMOTHER 奶奶/姥姥 | ||||
| FRIEND 朋友 | ||||
| WIFE 妻子 | ||||
| HUSBAND 丈夫 | ||||
| OTHER 其他 | ||||
| fundResource | 资金来源 | - | CASH 现金 | O |
| BANK_CARD_FUNDS 银行卡资金 | ||||
| ACCOUNT_FUNDS 账户资金 | ||||
| OTHER 其他 |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| payeeType | 收款人类型 | - | INDIVIDUAL 个人 | C |
| COMPANY 公司 | ||||
| 如果没有quotationId, 则payeeType为必填项 | ||||
| lastName | 收款人的姓 | varchar(100) | 收款人的姓（收款方是个人，lastname+firstname或fullname至少传一组） | C |
| middleName | 收款人的中间名 | varchar(100) | 收款人的中间名 | O |
| firstName | 收款人的名 | varchar(100) | 收款人的名（收款方是个人，lastname+firstname或fullname至少传一组） | C |
| fullName | 收款人全名 | varchar(100) | 收款人本国的全名（收款方是个人，lastname+firstname或fullname至少传一组） | C |
| companyName | 收款人公司名称 | varchar(100) | 收款人公司名称（收款方是公司时，必传） | C |
| companyRegistCerNo | 公司注册证书号码 | varchar(50) | 公司注册证书号码 (IDTYPE为REGISTCER时必填) | C |
| taxNo | 公司税号 | varchar(50) | 公司税号 (IDTYPE为TAX时必填) | C |
| companyRegistDate | 公司注册日期 | - | 公司注册日期；名称格式:yyyymmdd | O |
| companyRegistCountry | 公司注册国家 | - | 公司注册国家 | O |
| birthday | 收款人生日 | - | 收款人生日; 格式:yyyymmdd | O |
| birthCountry | 出生国代码 | - | 收款人出生国代码 | O |
| birthCity | 出生城市 | varchar(50) | 收款方出生城市 | O |
| country | 收款人国家代码 | - | 收款人国家代码 | M |
| province | 收款人所在省 | varchar(20) | 收款人所在省 | O |
| city | 收款人所在城市 | varchar(50) | 收款人所在城市 | O |
| address | 收款人地址 | varchar(255) | 收款人地址 | M |
| postcode | 邮政编码 | varchar(50) | 收款人的邮政编码 | O |
| gender | 收款人性别 | - | MALE 男 | O |
| FEMALE 女 | ||||
| phoneNumber | 收款人电话号码 | varchar(50) | 收款人电话号码 | O |
| 收款人邮箱 | varchar(100) | 收款人邮箱 | O | |
| idType | 收款人ID类型 | - | IDCARD 身份证 | M |
| PASSPORT 护照 | ||||
| REGISTCER 注册登记证 | ||||
| TAX 税务登记证 | ||||
| OTHER 其他 | ||||
| idNo | ID号码 | varchar(50) | 指定ID类型下的ID号; 当payeeType为INDIVIDUAL时idNo为必填项 | C |
| idEffectDateStart | ID的有效日期 | - | ID的有效日期; 格式为:yyyymmdd | O |
| idEffectDateEnd | ID失效日期 | - | ID失效日期; 格式为:yyyymmdd | O |
| profession | 收款人职业 | varchar(50) | 收款人的职业 | O |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| accountType | 收款人账户类型 | - | BANK_ACCOUNT 银行账户 | M |
| WALLET_ACCOUNT 钱包账户 | ||||
| CHECKING_ACCOUNT 支票账户 | ||||
| organCode | 接收组织的代码 | varchar(50) | 接收组织的代码, 如果不填quotationId， 则organCode是必填字段,如果填写quotationId，且在创建报价时未传入payeeOrgCode，则organCode是必填字段 | C |
| organCountry | 接收组织的国家代码 | - | 接收组织的国家代码, 如果不填quotationId， 则organCountry是必填字段 | C |
| organProvince | 接收组织的省 | varchar(20) | 接收组织的省 | O |
| organCity | 接收组织的市 | varchar(20) | 接收组织的市 | O |
| organAddress | 接收组织的地址 | varchar(255) | 接收组织的地址 | O |
| accountHolderName | 账户名 | varchar(100) | 账户名 | M |
| bankCardNumber | 收款人银行账户号码 | varchar(50) | 收款人银行账户号码 | O |
| 收款人邮箱地址 | varchar(100) | 收款人邮箱地址 | O | |
| phoneNumber | 收款人手机号 | varchar(50) | 收款人手机号 | O |
| ibanNumber | 国际银行账户号 | varchar(50) | 国际银行账户号，主要是欧洲国家 | O |
| ifscCode | 印度金融系统代码 | varchar(50) | 印度银行的印度金融系统代码 | O |
| aba | 美国银行家协会的路由号码 | varchar(50) | 美国银行家协会的路由号码 | O |
| clabe | 墨西哥银行代码 | varchar(50) | 墨西哥银行代码 | O |
| swiftCode | 环球银行金融电信协会号码 | varchar(50) | 环球银行金融电信协会号码 | O |
| sortCode | 排序代码 | varchar(50) | 排序代码，主要是英国银行的 | O |
| bsbNumber | 澳大利亚不同地区的银行代码 | varchar(50) | 澳大利亚不同地区的银行代码 | O |
| bankCode | 银行代码 | varchar(100) | 银行代码 | O |
| branchCode | 分行的代码 | varchar(20) | 分行的代码 | O |
| branchName | 分行的名称 | varchar(100) | 分行的名称 | O |
| bankName | 银行名称 | varchar(100) | 银行名称 | O |
| 参数名称 | 参数中文名称 | 类型& 长度 | 参数说明 | 是否必填 |
|---|---|---|---|---|
| fileSourceUrl | 文件源路径URL | varchar(255) | 文件源路径URL; 证明文件的SFTP的url地址; 商家将文件上传到Geoswift SFTP服务器; 连接方法参考《SFTP连接指南》 | C |
| fileType | 文件类型 | - | INVOICE 发票 | C |
| COMPANY 合同 | ||||
| PURCHASE_ORDER 采购订单 | ||||
| DELIVERY_ORDER 提货单 | ||||
| oddNumber | 文件类型编号 | varchar(50) | 指定文件类型上的编号 | O |
| 参数名称 | 参数中文名称 | 参数说明 |
|---|---|---|
| merchantId | 商户编号 | 商户在Geoswift系统中的唯一身份 |
| requestId | 订单号 | 同请求参数 |
| serialNumber | 流水号 | Geoswift系统返回的流水号 |
| status | 请求状态 | SUCCESS 成功 |
| FAILED 失败 | ||
| payerType | 付款人类型 | INDIVIDUAL 个人 |
| COMPANY 公司 | ||
| payeeType | 收款人类型 | INDIVIDUAL 个人 |
| COMPANY 公司 | ||
| remark | 备注 | 备注 |
| partnerId | 服务商编号 | 同请求参数 |
| hmac | 参数签名 | 汇元通生成的参数签名结果，验签过程请参考解密流程 |
| 参数名称 | 参数中文名称 | 参数说明 |
|---|---|---|
| merchantId | 商户编号 | 商户在Geoswift系统中的唯一身份 |
| requestId | 订单号 | 同请求参数 |
| serialNumber | 流水号 | Geoswift系统返回的流水号 |
| quotationId | 牌价ID | 牌价的唯一标识符 |
| quotationType | 牌价类型 | ORIGINAL 源汇款币种牌价 |
| TARGET 目标款币种牌价 | ||
| orderStatus | 汇款状态 | SUCCESS 成功 |
| FAILED 失败 | ||
| REVERSED 退票 | ||
| CANCELED 取消 | ||
| originalAmount | 源汇款金额 | 源汇款金额；单位:分 |
| originalCurrency | 源汇款币种 | 源汇款币种，见“币种列表” |
| targetAmount | 目标汇款金额 | 目标汇款金额；单位:分 |
| targetCurrency | 目标汇款币种 | 目标汇款币种, 见“币种列表” |
| rate | 汇率 | FX汇率; 保留8小数 |
| errorMessage | 错误信息 | 错误信息: 当orderStatus为FAILED时返回 |
| errorCode | 错误编号 | 错误编号: 当orderStatus为FAILED时返回 |
| completeDateTime | 汇款完成时间 | 汇款完成时间: 当orderStatus为SUCCESS或FAILED时返回; 北京时间; 格式为: yyyy-mm-dd hh:mm:ss |
| reversalDateTime | 汇款撤销退款时间 | 汇款撤销退款时间: 当orderStatus为REVERSED时，银行将资金退回的时间。北京时间，格式为yyyy-mm-dd hh:mm:ss |
| returnAmount | 退票金额 | 退票金额，仅退票通知时返回（单位分） |
| returnCurrency | 退票币种 | 退票币种，仅退票通知返回 |
| partnerId | 服务商编号 | 同请求参数 |
| partnerCommissionFeeType | 返佣计费模式 | 同接口请求参数 |
| partnerCommissionFeeValue | 返佣计费内容 | 同接口请求参数 |
| partnerCommissionAmount | 返佣金额 | 单位为分,不会为小数 |
| hmac | 参数签名 | 汇元通生成的参数签名结果，验签过程请参考解密流程 |