Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

创建订单

简要描述

发起汇款。字段较多,分为几部分组成。可结合业务理解参考中台订单创建流程。不同下发模式所需信息不一致,主要可分为 wire 和其他(bank_account、cash_pickup、ewallet)。其他类型均为 C2C 模式,仅 wire 支持 B2B、B2C、C2B,wire 的校验较少。


请求URL

${baseUrl}/tf/v4/order/create

请求方式

  • Method:POST
  • Content-Type:application/json

参数说明

参数名必选类型说明条件
merOrderNostring商家订单号,唯一
notifyUrlstring订单通知地址,如提供则订单状态变更时会主动通知
extstring预留字段,处理特殊业务

金额相关

参数名必选类型说明条件
sourceCurrencystring使用的汇款备用金,例如USD、EUR。可先查询余额接口获取当前配置资金货币和金额。country=CHN && type=bank_account && currency=CNY 只支持USD
sendAmountstring发送金额,与 targetAmount 只能二选一,最多两位小数关联 sourceCurrency
targetAmountstring到账金额,与 sendAmount 只能二选一,最多两位小数。部分地区要求整数,有小数将自动去除,建议只用整数关联 currency
chargeCodestringwire的费用承担方式,默认 SHA;如 FP(支持时可在获取报价接口查看),费用由订单承担,客户收到全部 targetAmount/sendAmount 金额。type=wire

下发路径

参数名必选类型说明条件
countrystring目的国家,如 HKG
businessstring业务类型,如 C2C,参考数据
typestring下发通道,如 wire、ewallet、bank_account
currencystring下发币种,如 HKD,参考数据
partnerstring下发通道支持的合作伙伴,如 partner_ewallet,来源接口

收款账号相关

参数名必选类型说明条件
accountNumberstring银行账号type=bank_account 或 type=wire,accountNumber/iban 只能选一
ibanstringIBANtype=bank_account 或 type=wire,accountNumber/iban 只能选一;type=bank_account && currency=EUR
targetBankCodestring银行编码,如 003,来源接口type=bank_account
targetBankBranchstring银行分行,如 003-01,如有 bankCode 需查询type=bank_account
swiftCodestringSWIFT codetype=wire
corrSwiftCodestring代理行/中转行SWIFT codetype=wire,可选填
ewalletIdstring电子钱包账户type=ewallet
routingCodestring银行ABA路由代码,9位数字type=bank_account 且 country=AUS
sortCodestring排序代码(英国6位),格式3对数字type=bank_account && country=GBR && currency=GBP

收款方信息

参数名必选类型说明条件
targetAddressLinestring详细地址,备注勿重复填写国家和城市
targetAddressCitystring城市
targetAddressCityCodestring城市编码,如0926,来源接口country=IDN && business=C2C && type=ewallet
targetAddressStatestring州/省编码,如09,如为IDN需提交name,来源接口
targetAddressZipstring邮编C CAN-bank_account-CAD
targetAddressCountrystring国家或地区,如 HKG
targetMobileNumberstring手机号,如+6281329623212C,cash_pickup,type=ban_account_new && country=CHN
targetCompanyNamestring企业名称B 必填
targetNameFirststring名字C 必填
targetNameLaststring姓氏C 必填
targetNativeNameFirststring国籍本地名C,type=ban_account_new && country=CHN
targetNativeNameLaststring国籍本地姓C,type=ban_account_new && country=CHN
targetNationalitystring国籍,如 HKGC 必填
targetDateOfBirthstring出生年月,格式1999-10-01C,KOR-bank_account-KRW
targetEmailstring邮箱C,KOR-bank_account-KRW & targetMobileNumber非+82号码
targetIdNumberstring证件号C
targetIdTypestring证件类型,national/护照C,type=cash_pickup && country=VNM,targetIdNumber不为空需完善
targetIdExpirationstring证件有效期,格式1999-10-01,长期用2099-12-31C

发送方信息

参数名必选类型说明条件
sourceCountrystring发送国家或地区,需为跨境,必须与country不同来源接口
sourceReferenceNumberstring参考编号,C时必填,用于标识当前用户,便于找回
sourceAddressLinestring详细地址
sourceAddressCitystring城市
sourceAddressStatestring州/省C,type=ban_account_new && country=CHN
sourceAddressCountrystring国家
sourceAddressZipstring邮编
sourceNameFirststring名字C 必填
sourceNameLaststring姓氏C 必填
sourceGenderstring性别(M/F)C,type!=wire && country=NPL
sourceNationalitystring国籍,如HKGC 必填
sourceDateOfBirthstring出生年月,格式1999-10-01C 必填
sourceIdNumberstring证件号C,country=IDN && business=C2C && type=ewallet;country=CHN && business=C2C && type=bank_account
sourceIdTypestring证件类型,national/护照,sourceIdNumber不为空需完善C
sourceIdExpirationstring证件有效期,格式1999-10-01,长期用2099-12-31C
sourceIdIssueCountrystring证件签发国家,sourceIdNumber有值需完善C,sourceIdNumber有值
sourceMobileNumberstring手机号C,详见下方规则
sourceCompanyNamestring企业名称B 必填
sourceCompanyTradingNamestring企业经营名称B 必填
sourceCompanyRegistrationNumberstring企业注册号B
sourceCompanyRegistrationCountrystring企业注册国家或地区B

订单附属信息

参数名必选类型说明
remittancePurposestring交易目的,参考数据
sourceOfFundsstring资金来源,参考数据
relationshipstring交易关系,参考数据
occupationstring发送者职业,参考数据
unformattedNotestring转账附言,最大长度64

字段规则说明

  • sourceMobileNumber,targetMobileNumber
    • business=C2C && type=bank_account && country in (CMR, COG, GHA, KEN, UGA, BGD, CAD, IDN, KRW, NPL, USA, VNM)
    • business=C2C && type=ewallet && country in (BEN, CMR, COG, GHA, MDG, MWI, MOZ, NER, RWA, SEN, TZA, TGO, UGA, ZMB, BGD, IDN, NPL)
    • business=C2C && type=cash_pickup && country in (BGD, KHM, IDN, KRW, NPL, PHP, VNM)
  • sourceIdNumber
    • country=IDN && business=C2C && type=ewallet
    • country=CHN && business=C2C && type=bank_account
    • type=wire && country=HKG && currency=HKD
    • type=wire && country=AUS && currency=AUD
    • type=wire && country=SGP && currency=SGD
  • sourceAddressCountry、targetAddressCountry
    • type=wire && country=HKG && currency=HKD
    • type=wire && country=AUS && currency=AUD
    • type=wire && country=SGP && currency=SGD

返回示例

{
    "data": {
        "account": "543435",
        "completeTime": "",
        "createTime": "2024-08-31 23:08:58",
        "ext": "",
        "failReason": "",
        "merOrderNo": "240831230857132800",
        "orderNo": "240831230858245344",
        "sendAmount": 0,
        "chargeCode": "FP",
        "fullPayFee": "20",
        "fixedFee": 5,
        "preRatedFee": 0.012,
        "sourceAmount": 1586.15,
        "sourceCurrency": "USD",
        "status": 0,
        "targetAmount": 10000,
        "targetCurrency": "CNY"
    },
    "msg": "操作成功",
    "status": 200,
    "success": true
}

返回参数说明

参数名称示例参数说明schema
datajsonArray响应数据产品类型列表
msg操作成功响应消息
status200响应码
successtrue是否成功(true-成功,false-失败)

data-下单订单信息说明

参数名称示例参数说明
merOrderNo436343534234商家订单号
orderNo35432346345345平台订单号
account6244810070000117目标账户
sourceCurrencyUSD结算币种
sourceAmount20.1234结算金额,最多保留四位小数
sendAmount20.发送金额,选用 sendAmount 时有值,否则为0
targetCurrencyCNY目标币种
targetAmount10000目标金额
merQuotes7.2634提单的报价
chargeCodeSHAwire的费用承担方式
fullPayFee20FP承担费用时,sourceAmount包含此费用
fixedFee12固定费用,与sourceCurrency同币种
preRatedFee0.012兑换手续费,例如发送金额100,则此项为100*0.012
status1订单状态(1-处理中 2-成功 3-失败)
failReason信息错误失败信息,如失败时会返回
createTime2023-04-02 17:07:09订单创建时间
completeTime2023-04-02 17:07:09订单完成时间
ext订单额外信息,预留

业务状态码说明

状态码描述
200成功
500操作失败(不可直接失败,需查询订单后确定)
5000操作异常(需查询订单确认)
5101请勿重复下单
5102备用金余额不足