本章节描述商户接入BZcircle相关业务接口。
M表示必输字段，O表示可选字段

5.1 商户入网

5.1.1 代理商商户入网和VA开户整合

1 功能描述

交易代码	TP1020
功能名称	代理商商户入网和VA开户整合
功能描述	收集商户资料，完成商户入网和VA开户，分为新增和修改功能，存在字段bizFlow为修改功能，修改功能仅支持拒绝字段修改，非拒绝字段不予处理，拒绝会同步拒绝VA，请求修改接口且需要同步开通VA时需同时重新上传VA信息
调用方式	实时接口
调用流程	--
应用场景	本指引目的为BZcircle收集商户资料信息，BZcircle方资质审查后，予以商户资质审批通过和VA审批通过，可为商户提供后续服务。

2 请求地址
Url： https://{baseUrl}/api/tp1020

3 请求参数

名称	Json标签	类型	属性	取值说明
商户唯一订单号	merOrderNo	string(32)	M	商户唯一订单号
入网申请唯一订单号	bizFlow	string(32)	C	入网申请唯一订单号，仅修改功能必传，由新增功能同步返回
入网邮箱	email	string(64)	M	唯一入网邮箱
手机区号	phoneAreaCode	string(10)	M	手机号区号
手机号	phoneNum	string(32)	M	唯一入网手机号
推荐代理商	referralChannel	string(16)	M	注册推荐代理商编号 (Easyloon提供) 测试环境默认： 0000000000
商户注册国家/地区	countryCode	string(2)	M	注册国家/地区 iso 二字码
商户英文名	merNameEn	string(255)	M	唯一入网商户的英文名
商户中文名	merNameCn	string(255)	C	入网商户的中文名，注册国家为中国时必填
公司成立日期	establishDate	string(16)	M	公司成立日期，格式：yyyy-MM-dd
商业登记证或企业证件到期日	brExpiryDate	string(16)	M	商业登记证或企业证件到期日，格式：yyyy-MM-dd
公司注册地址	registrationAddress	string(255)	M	公司注册地址
全国工商企业文件	enterprisePath	List	C	全国工商企业文件，注册国家为中国大陆时必填请至https://www.gsxt.gov.cn/index.html注册下载报告
是否具有母公司	parentRemark	string(2)	M	是否具有母公司 0：无 1：有
股权架构图	ownerShipPath	List	C	当具有母公司时，该值必传
母公司注册证明	parentCertificate	List	C	当具有母公司并且非中国大陆时，该值必传
母公司信息	parentCompany	List	C	当具有母公司时，该值必传
是否具有子公司	branchRemark	String(2)	M	是否具有子公司或分公司 0：无 1：有
分公司/子公司信息	branchCompany	List	C	当有子公司或者分公司时必传
商户注册文件	certificate	List	M	商户注册证明，中国大陆提供营业执照，香港提供商业登记证，境外传公司注册证明
商户注册证件号	certificateNumber	String(255)	M	商户注册证件号，中国大陆提供营业执照证件号，香港提供商业登记证（BR）号码，境外传公司注册证书（CI）号码
公司注册证书	companyCertificate	List	C	公司注册证书(文件)，当公司属于香港时必传
公司注册证书号码	companyCertificateNumber	String(255)	C	公司注册证书（CI）号码，当公司属于香港时必传
收款付款参与方	participantsType	List	M	主要的收款付款参与方是公司还是个人 0:公司 1:个人
法团成立表	nnc1Path	List	C	当公司为非中国大陆必传上传最新法团成立表NNC1的照片或扫描件
周年年报	nar1Path1	List	O	当公司为境外公司选传若您公司成立一年以上，请上传最新周年年报的照片或扫描件
公司章程	mermorandum	List	C	当公司为境外公司必传
被授权人身份	customerIdentity	List	M	入网客户被授权人的身份参数详见6.1.10字段说明
被授权人信息	customer	List	M	被授权人信息
持股25%以上股东	shareholder	List	M	持股25%以上股东的信息
公司董事	director	List	C	公司董事信息，非中国大陆国家必传
法人	legalPerson	List	C	法人信息，国家为中国大陆时必传
董事会议授权书	authorization	List	M	董事会议授权书注：需要满足以下条件：授权书需加盖公章，董事/法人签字或签章以及被授权人签字
资金来源	sourceFunds	List	M	资金主要来源参数详见6.1.8字段说明
付款目的	paymentPurpose	List	M	付款主要目的参数详见6.1.9字段说明
风险交易国家/地区	riskCountryTransaction	String(2)	M	0：无 1：有是否有伊朗、朝鲜、古巴地区有任何直接或间接的业务
风险国家信息	riskCountries	List	C	当有和以上风险国家企业交易时，提供企业信息
是否为补充请求	addMaterial	String(2)	O	0：否 1：是当回调code为80000时，需要请求加上补充材料
补充材料	reMaterial	reMaterial	O	回调code为80000时，需要传参
公司真实营业地址	realCompanyAddress	string(255)	M	公司真实营业地址
公司真实营业地址证明材料	addressMaterial	List	O	公司真实营业地址证明材料一、当注册主体为中国大陆, 请至少以下提供一种：1.近三个月内同名公司银行对账单，首页需包含地址（优先提供）；2.近三个月内同名公司的增值税发票，需包含地址（优先提供）；3.近三个月内同名公司的官方水电费账单，需包含地址；4.包含地址的公司产品目录、服务手册、广告单或宣传单张等。二、当注册主体是香港公司,但其总公司在中国大陆或在中国大陆有直接联系的公司，请提供该中国大陆公司营业执照。注：提供该信息有助于加快入网
公司地址类型	addressType	string(1)	M	公司地址类型 0自租办公室 1秘书处地址 2共享办公室
公司官网	companyWebsite	string(128)	O	公司官网地址注：提供该信息有助于加快入网
主要客户所在国家/地区	clientCountry	List	M	主要客户所在国家/地区 (国家二字码)
业务所在国家/地区	businessCountry	List	M	在哪个国家/地区经营（开展）业务 (国家二字码)
目前合作伙伴和供应商所在国家/地区	suppliersCountry	List	M	目前合作伙伴和供应商所在国家/地区 (国家二字码)
目前和预计需要的收款服务的汇入国家/地区	inCountry	List	M	目前和预计需要的收款服务的汇入国家/地区 (国家二字码)
目前和预计需要的付款服务的汇出国家/地区	outCountry	List	M	目前和预计需要的付款服务的汇出国家/地区 (国家二字码)
去年的营业额（USD）	lastYearTurnover	string(2)	M	去年的营业额（USD）参数详见6.1.16字段说明
预估交易量 (每月)(USD)	transactionAmount	string(2)	M	预估交易量 (每月)(USD) 参数详见6.1.17字段说明
交易模式	transaction	List	M	交易模式
销售网址或者app名	webSiteOrApp	string(350)	C	销售网址或者app名 transaction中tradeType存在1时填写
业务性质	businessNature	BusinessNature	M	业务性质
是否通知	noticeMarker	string(1)	M	是否邮件短信通知商户 0不通知 1通知
回调地址	callBackUrl	String(255)	M	用于接收商户入网结果,必须http/https开头
其他附件	otherPath	String(255)	O	其他附件（仅允许单个地址，多个文件打包上传）
附言	postscript	String(255)	O	附言
是否同步开通VA	vaFlag	string(1)	M	是否同步开通VA，0不开通，1开通
VA信息	vaInfo	List	C	开通VA信息，vaFlag=1时必填

Transaction

名称	Json标签	类型	属性	取值说明
交易模式	tradeType	string(1)	M	交易模式 0:线下交易 1:线上交易
交易模式分类	tradeOption	string(1)	M	选项 tradeType为0时{0:品牌商 1:代理商} tradeType为1时{0:WEB 1:APP}
品牌代理商所在国家/地区	country	string(1)	C	国家/地区（国家二字码） tradeType为0时填写

BusinessNature

名称	Json标签	类型	属性	取值说明
业务性质类型	natureType	String(2)	M	性质类型 0货贸 1服贸
业务性质	natures	List	M	业务性质明细 natureType为0时参数详见6.1.11字段说明 natureType为1时参数详见6.1.12字段说明

reMaterial

名称	Json标签	类型	属性	取值说明
财务报表或公司税务申报表/完税证明	financialStatements	List	M	财务报表或公司税务申报表/完税证明
调查表	questionnaire	List	M	调查表
表现最好的3家客户	bestCustomer	List	M	表现最好的3家企业信息
表现最好的3家供应商/合作伙伴公司	bestPartner	List	M	表现最好的3家供应商/合作伙伴公司信息

personalInfo

名称	Json标签	类型	属性	取值说明
证件类型	type	String(2)	M	证件类型 0 身份证 1 护照
姓名	name	String(255)	M	客户姓名
证件签发国家/地区	issuPlace	String(2)	M	国家ISO 二字码
国籍	nationality	String(2)	M	国家ISO 二字码
有效证件号码	idNumber	String(64)	M	有效证件号码
出生日期	birthDate	String(16)	M	出生日期，格式：yyyy-MM-dd
证件到期日期	certificateDate	String(16)	M	证件到期日期，格式：yyyy-MM-dd
居住国家/地区	residenceCountry	String(2)	M	国家ISO 二字码
居住地址	address	String(255)	C	居住地址除被授权人外其余必传
证件文件	certificates	List	M	证件sftp地址

companyInfo

名称	Json标签	类型	属性	取值说明
公司名称	name	String(64)	M	公司注册名称
公司注册国家/地区	country	String (2)	M	公司所在国家/地区

VaInfo

名称	Json标签	类型	属性	取值说明
商户唯一订单号	merOrderNo	string(32)	M	商户唯一订单号
申请大类	parentCode	string(1)	M	申请大类，暂时只支持 S:平台电商 D:独立站电商 T:线下一般货贸 F:服务贸易
申请子类	applyCode	string(64)	M	申请子类,填写业务子英文名详见6.1.13申请子类字段
收款国家/地区	area	string(2)	M	收款国家/地区标准2字代码
收款币种	currency	string(3)	M	收款币种，3位标准货币代码
账户简称	acctSimpleName	string(128)	M	账户简称
银行类	bankType	string(3)	O	银行类，填写银行类枚举值，仅线下一般货贸、服务贸易选填详见6.1.14bankType 银行类
店铺名称	shopName	string(128)	M	店铺名称
店铺链接	shopUrl	string(350)	O	店铺链接，平台电商、独立站电商必填
收单方式	collectType	string(12)	O	收单方式，枚举值：PayPal,stripe,other 仅独立站中自建站必填
收单方式名称	collectName	string(127)	O	收单方式名称，collectType为 other时填写
销售地址	webSiteUrl	string(350)	O	销售地址，线下一般货贸、服务贸易填写，与业务说明文件必填其一，可全填
是否同名	isSameName	string(1)	M	是否同名 Y:是 N:否
业务说明文件	busDesDocument	List	O	多个附件文件地址数组，线下一般货贸、服务贸易填写，与销售地址必填其一，可全填
店铺持有证明	storeHoldCertify	List	O	多个附件文件地址数组，电商、独立站提交
回调地址	callBackUrl	String(255)	M	用于接收商户VA申请结果
VA其他附件	otherPath	String(255)	O	其他附件（仅允许单个地址，多个文件打包上传）
VA附言	postscript	String(255)	O	附言

请求示例:

{
  "addMaterial": "0",
  "addressMaterial": [
    "uploadFile/hzfr.jpg"
  ],
  "addressType": "2",
  "authorization": [
    "uploadFile/hzfr.jpg"
  ],
  "brExpiryDate": "2031-11-11",
  "branchCompany": [
    {
      "country": "CN",
      "name": "companyInfo1"
    },
    {
      "country": "US",
      "name": "companyInfo2"
    }
  ],
  "branchRemark": "1",
  "businessCountry": [
    "UZ"
  ],
  "businessNature": {
    "natureType": "0",
    "natures": [
      "8",
      "4"
    ]
  },
  "callBackUrl": "https://www.baidu.com",
  "certificate": [
    "uploadFile/hzfr.jpg"
  ],
  "certificateNumber": "02224230995",
  "clientCountry": [
    "UZ"
  ],
  "companyCertificate": [
    "uploadFile/hzfr.jpg",
    "uploadFile/hzfr.jpg"
  ],
  "companyCertificateNumber": "87361378062",
  "companyWebsite": "https://www.baidu.com",
  "countryCode": "CN",
  "customer": [
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "CN",
      "name": "test001",
      "nationality": "CN",
      "residenceCountry": "CN",
      "type": "0"
    },
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "HK",
      "name": "test002",
      "nationality": "HK",
      "residenceCountry": "HK",
      "type": "0"
    }
  ],
  "customerIdentity": [
    "0",
    "1"
  ],
  "director": [
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "CN",
      "name": "test001",
      "nationality": "CN",
      "residenceCountry": "CN",
      "type": "0"
    },
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "HK",
      "name": "test002",
      "nationality": "HK",
      "residenceCountry": "HK",
      "type": "0"
    }
  ],
  "email": "12042736@00.com",
  "enterprisePath": [
    "uploadFile/hzfr.jpg"
  ],
  "establishDate": "2011-11-11",
  "inCountry": [
    "UZ"
  ],
  "lastYearTurnover": "1",
  "legalPerson": [
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "CN",
      "name": "test001",
      "nationality": "CN",
      "residenceCountry": "CN",
      "type": "0"
    }
  ],
  "merNameEn": "LNQ169275783313408",
  "merOrderNo": "LNQ1692757833134",
  "mermorandum": [
    "uploadFile/hzfr.jpg"
  ],
  "nar1Path1": [
    "uploadFile/hzfr.jpg"
  ],
  "nnc1Path": [
    "uploadFile/hzfr.jpg"
  ],
  "noticeMarker": "0",
  "otherPath": "uploadFile/hzfr.jpg",
  "outCountry": [
    "UZ"
  ],
  "ownerShipPath": [
    "uploadFile/hzfr.jpg",
    "uploadFile/hzfr.jpg"
  ],
  "parentCertificate": [
    "uploadFile/hzfr.jpg",
    "uploadFile/hzfr.jpg"
  ],
  "parentCompany": [
    {
      "country": "CN",
      "name": "companyInfo1"
    },
    {
      "country": "US",
      "name": "companyInfo2"
    }
  ],
  "parentRemark": "1",
  "participantsType": [
    "0"
  ],
  "paymentPurpose": [
    "4",
    "5"
  ],
  "phoneAreaCode": "86",
  "phoneNum": "18734183423",
  "postscript": "",
  "realCompanyAddress": "紫禁之巅",
  "referralChannel": "0000000000",
  "registrationAddress": "紫禁之巅",
  "riskCountryTransaction": "0",
  "shareholder": [
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "CN",
      "name": "test001",
      "nationality": "CN",
      "residenceCountry": "CN",
      "type": "0"
    },
    {
      "address": "紫禁之巅",
      "birthDate": "1977-07-21",
      "certificateDate": "2038-07-21",
      "certificates": [
        "uploadFile/hzfr.jpg"
      ],
      "idNumber": "370121197707211040",
      "issuPlace": "HK",
      "name": "test002",
      "nationality": "HK",
      "residenceCountry": "HK",
      "type": "0"
    }
  ],
  "sourceFunds": [
    "4",
    "5"
  ],
  "suppliersCountry": [
    "UZ"
  ],
  "transaction": [
    {
      "country": "CN",
      "tradeOption": "1",
      "tradeType": "0"
    }
  ],
  "transactionAmount": "1",
  "vaFlag": "1",
  "vaInfo": [
    {
      "acctSimpleName": "LNQ1692757833134",
      "applyCode": "ELECTRONIC_OPTICAL_PRODUCTS",
      "area": "US",
      "callbackUrl": "https://www.baidu.com",
      "currency": "USD",
      "isSameName": "Y",
      "merOrderNo": "VA_LNQ1692757833134_01",
      "parentCode": "T",
      "shopName": "https://www.baidu.com",
      "webSiteUrl": "https://www.baidu.com"
    },
    {
      "acctSimpleName": "LNQ1692757833134",
      "applyCode": "ELECTRONIC_OPTICAL_PRODUCTS",
      "area": "US",
      "callbackUrl": "https://www.baidu.com",
      "currency": "USD",
      "isSameName": "Y",
      "merOrderNo": "VA_LNQ1692757833134_02",
      "parentCode": "T",
      "shopName": "https://www.baidu.com",
      "webSiteUrl": "https://www.baidu.com"
    }
  ],
  "webSiteOrApp": "https://www.baidu.com"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
业务流水号	bizFlow	string(32)	M	入网申请唯一订单号
商户唯一订单号	merOrderNo	string(32)	O	商户唯一订单号
状态	status	string(6)	M	申请状态码 ACCEPT:接收成功，等待回调 SUCC:审核通过 FAIL:失败 REFUSE:审核拒绝
结果码	code	string(6)	M	响应结果代码，S00001 代表已接收成功，
				等待Easyloon审核后回调
结果描述	message	string(255)	M	响应描述

返回示例:
{
  "bizFlow": "230823103034820183",
  "code": "S00001",
  "merOrderNo": "LNQ1692757833134",
  "message": "Processing",
  "status": "ACCEPT"
}

5.1.2 商户入网结果通知

1 功能描述

名称	Json标签	类型	属性	取值说明
交易代码	TP2004	string(32)	M	入网申请唯一订单号
功能名称	商户入网结果通知	string(32)	O	商户唯一订单号
功能描述	商户入网结果异步通知	string(6)	M	申请状态码 ACCEPT:接收成功，等待回调 SUCC:审核通过 FAIL:失败 REFUSE:审核拒绝
调用方式	通知接口	string(6)	M	响应结果代码，S00001 代表已接收成功，
调用流程	--			等待BZcircle审核后回调
应用场景	"商户入网信息完善发起成功且交易处理完毕后，
将根据商户入网信息完善参数内的回调Url进行回调通知最终结果。	" string(255)	M	响应描述

提示

本通知将按照间隔时间渐长的方式持续通知24小时.商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址

Url：商户入网信息完善中的 callbackUrl
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
业务流水号	bizFlow	string(32)	M	入网申请唯一订单号
商户唯一订单号	merOrderNo	string(32)	O	商户唯一订单号
结果码	code	string(6)	M	响应结果代码，S00000 代表入网成功
结果描述	message	string(255)	M	响应描述
商户号	merchantNo	string(32)	M	商户号，为商户的唯一标识号码
商户英文名称	merNameEn	string(255)	M	商户英文名称
授权码	authorizeCode	string(32)	M	授权码

请求示例:
{
  "authorizeCode": "6406903b413c0abaeb7afb6c76025074",
  "bizFlow": "230823103034820183",
  "code": "S00000",
  "merNameEn": "LNQ169275783313408",
  "merOrderNo": "LNQ1692757833134",
  "merchantNo": "008850102219",
  "message": "Success",
  "status": "SUCC"
}

5.2 授权

5.2.1 申请授权

1 功能描述


交易代码	TP9001
功能名称	申请授权
功能描述	用户需在BZcircle 侧完成OAuth 认证，用户在完成授权后，代理商可获得对用户数据操作的权限。
调用方式	浏览器链接
调用流程	--
应用场景	名下商户获取接口的权限

2 请求地址
Url： https://{baseUrl}/api/TP9001
Method：链接

3 请求字段

名称	Json标签	类型	属性	取值说明
重定向URL	redirectUrl	string(255)	M	重定向 url，生产https://msp.bzcircle.com/ 测试https://uat.msp.bzcircle.com/
商户编号	merchantNo	string(255)	M	代理商的商户号

4 响应字段

名称	Json标签	类型	属性	取值说明
授权码	authorizeCode	string(32)	M	授权码

5.2.2 申请token

1 功能描述

交易代码	TP9002
功能名称	申请token
功能描述	获取商户唯一token，用于后续接口交易
调用方式	实时接口
调用流程	--
应用场景	代理商需要为名下商户提交交易时

2 请求地址
Url： https://{baseUrl}/api/TP9002
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
授权码	authorizeCode	string(32)	M	授权码

请求示例:
{
  "authorizeCode": "e10adc3949ba59abbe56e057f20f883e"
}

4 响应字段 | 名称 | Json标签 | 类型 | 属性 | 取值说明 | | --- | --- | --- | --- | --- | | 授权token | accessToken | string(32) | M | 授权 Token(目前 Token 永久有效) |

返回示例:
{
  "accessToken": "7c4a8d09ca3762af61e59520943dc26494"
}

5.3 收款

5.3.1 VA开户申请

1 功能描述

交易代码	TP1017
功能名称	VA开户申请
功能描述	商户发起VA开户申请，等待BZcircle审核后，商户可通过VA查询接口查询具体VA账户信息
调用方式	异步接口
调用流程	--
应用场景	商户发起VA开户申请

2 请求地址
Url： https://{baseUrl}/api/tp1017
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	string(32)	M	商户唯一订单号
申请大类	parentCode	string(1)	M	申请大类，暂时只支持 S:平台电商 D:独立站电商 T:线下一般货贸 F:服务贸易
申请子类	applyCode	string(64)	M	申请子类,填写业务子英文名详见6.1.13申请子类字段
收款国家/地区	area	string(2)	M	收款国家/地区标准2字代码
收款币种	currency	string(3)	M	收款币种，3位标准货币代码
账户简称	acctSimpleName	string(128)	M	账户简称
银行类	bankType	string(3)	O	银行类，填写银行类枚举值，仅线下一般货贸、服务贸易选填详见6.1.14bankType 银行类
店铺名称	shopName	string(128)	M	店铺名称
店铺链接	shopUrl	string(350)	O	店铺链接，平台电商、独立站电商必填
收单方式	collectType	string(12)	O	收单方式，枚举值：PayPal,stripe,other 仅独立站中自建站必填
收单方式名称	collectName	string(127)	O	收单方式名称，collectType为 other时填写
销售地址	webSiteUrl	string(350)	O	销售地址，线下一般货贸、服务贸易填写，与业务说明文件必填其一，可全填
是否同名	isSameName	string(1)	M	是否同名 Y:是 N:否
回调URL	callbackUrl	string(255)	M	回调URL
业务说明文件	busDesDocument	Array	O	多个附件文件地址数组，线下一般货贸、服务贸易填写，与销售地址必填其一，可全填
店铺持有证明	storeHoldCertify	Array	O	多个附件文件地址数组，电商、独立站提交
其他附件	otherPath	string(255)	O	其他附件其他补充附件，多个附件以,相隔
附言	postscript	string(255)	O	附言其他补充说明文字
账户持有人ID	holderId	string(64)	O	账户持有人ID ，不传默认以企业主体开通VA

请求示例:
{
  "acctSimpleName": "test001",
  "applyCode": "SHOPEE_IN",
  "area": "ID",
  "callbackUrl": "https://api.***.com/callback",
  "collectName": "",
  "collectType": "PayPal",
  "currency": "IDR",
  "isSameName": "N",
  "merOrderNo": "LNQ1692771393185",
  "parentCode": "S",
  "shopName": "31312",
  "shopUrl": "https://test001",
  "webSiteUrl": "https://test001"
}

具体申请条件详见6.1.15申请条件明细
4 响应字段

名称	Json标签	类型	属性	取值说明
业务流水号	bizFlow	string(32)	M	BZcircle侧唯一业务订单号
结果状态	status	string(6)	M	结果状态 ACCEPT:接收成功 FAIL：失败

返回示例:
{
  "bizFlow": "80823082314163300199",
  "status": "ACCEPT"
}
def)

5.3.2 VA开户查询

1 功能描述

交易代码	TP3012
功能名称	VA开户查询接口
功能描述	VA开户查询接口，提交VA申请后，通过此接口查询账户具体信息
调用方式	实时接口
调用流程	--
应用场景	VA开户查询接口

2 请求地址
Url： https://{baseUrl}/api/tp3012
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long(13)	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long(13)	O	Unxi13位时间戳，查询结束时间，闭区间
BZcircle侧业务订单号	bizFlow	String(32)	O	VA开户时返回的订单号
商户订单号	merOrderNo	String(32)	O	商户订单号

请求示例:
{
  "bizFlow": "80823082314163300199"
}

提示

若startTime与endTime没填，则bizFlow和merOrderNo中必填其一。若bizFlow和merOrderNo都没填，则startTime与endTime为必填。根据startTime和endTime的查询，最多显示100条。

4 响应字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	String(32)	M	商户订单号
BZcircle侧业务订单号	bizFlow	String(32)	M	VA开户时返回的订单号
VA详细信息	vaInfos	List	M	VA详细信息

VaInfo 的字段

名称	Json标签	类型	属性	取值说明
VA账户名称	accountName	string(255)	O	VA账户名称
VA账户号	accountNo	string(64)	O	VA账户号
SwiftCode	swiftCode	string(11)	O	银行的SwiftCode
银行名称	bankName	string(128)	O	银行名称
银行地址	bankAddress	string(255)	O	银行地址
国家/地区	area	string(64)	O	国家/地区
银行Code	bankCode	string(12)	O	银行Code
分行号	branchCode	string(12)	O	分行号
支持币种	currency	string(255)	O	支持币种，多币种之间按照
VA账户状态	status	string(8)	M	VA账户状态, ON:启用，OFF：禁用/拒绝 OPENING：开户中
备注	remark	string(8)	O	当为OFF时，会展示具体禁用/拒绝原因
申请时间	createTime	long	M	VA开户的申请时间
修改时间	updateTime	long	M	VA开户的修改时间

返回示例:
{
  "list": [
    {
      "bizFlow": "80823082314163300199",
      "merOrderNo": "LNQ1692771393185",
      "vaInfos": [
        {
          "accountName": "XDT-GUANGZHOU HELIBAO PAYMENT CO LTD",
          "accountNo": "8808999911436641",
          "area": "ID",
          "bankAddress": "Wisma BNI, Jakarta",
          "bankCode": "016",
          "bankName": "Bank Negara Indonesia（BNI）",
          "branchCode": "478",
          "codeName": "Bank Code",
          "createTime": 1692771393951,
          "currency": "IDR",
          "parentCode": "S",
          "remark": "",
          "status": "ON",
          "swiftCode": "0090081",
          "updateTime": 1692771615635
        }
      ]
    }
  ]
}

5.3.3 贸易收款到账通知

1 功能描述

交易代码	TP2007
功能名称	贸易收款到账通知
功能描述	贸易收款到账通知
调用方式	通知接口
调用流程	--
应用场景	在商户的VA子账户收款收到后，BZcircle会向商户发送贸易收款资金到账的通知

提示

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址
Url：【待补充】callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
到账流水号	flowNo	string(32)	M	贸易收款到账唯一流水号
到账金额	receiveAmount	decimal(18,2)	M	VA到账金额
到账币种	receiveCurrency	string(3)	M	VA到账币种
入账VA账户号	vaAccount	string(16)	M	入账的VA账户号
付款方名称	senderName	string(64)	O	付款方名称
付款方账号	senderAccount	string(32)	O	付款方账号
入账时间	receiveTime	string(10)	M	入账时间，10位unix时间戳
手续费金额	feeAmount	decimal(18,2)	O	手续费金额
手续费币种	feeCurrency	string(3)	O	手续费币种
实际入账金额	actualReceiveAmount	decimal(18,2)	M	实际入账金额
金额是否可用	availableFlag	string(1)	M	金额是否可用 0:不可用 1:可用
交易类型	receiveType	string(1)	M	交易类型 S:平台电商 D:独立站电商 T:线下一般货贸 F:服务贸易
汇款附言	tradeComments	string(1024)	O	汇款附言

请求示例:
{
  "actualReceiveAmount": 1000,
  "availableFlag": "0",
  "feeAmount": 5,
  "feeCurrency": "USD",
  "flowNo": "62323082314263700034",
  "receiveAmount": 1000,
  "receiveCurrency": "IDR",
  "receiveTime": "1692772093",
  "receiveType": "S",
  "senderAccount": "",
  "senderName": "20230823002.ltd",
  "tradeComments": "",
  "vaAccount": "8808999911436641"
}

5.3.4 收款VA入账查询接口

1 功能描述

交易代码	TP3015
功能名称	收款VA入账查询接口
功能描述	收款VA入账查询接口
调用方式	实时接口
调用流程	--
应用场景	可以查询VA账户具体的到账流水

2 请求地址
Url： https://{baseUrl}/api/tp3015
Method： POST

3 请求字段

名称	Json标签	类型	属性
名称	Json标签	类型	属性
查询起始时间	startTime	Long(13)	O
查询结束时间	endTime	Long(13)	O
VA入账订单号	flowNo	string(32) O	VA入账订单号

请求示例:
{
  "flowNo": "62323082314263700034"
}

提示

startTime与endTime，间隔不能超过24小时。根据startTime和endTime的查询，最多显示100条。若startTime和endTime未填写，则bizFlow为必填。

4 响应字段

名称	Json标签	类型	属性	取值说明
交易流水号	flowNo	string(32)	M	贸易收款到账唯一流水号
到账金额	receiveAmount	decimal(18,2)	M	VA到账金额
到账币种	receiveCurrency	string(3)	M	VA到账币种
入账VA账户号	vaAccount	string(16)	M	入账的VA账户号
付款方名称	senderName	string(64)	O	付款方名称
付款方账号	senderAccount	string(32)	O	付款方账号
入账时间	receiveTime	string(10)	M	入账时间，10位unix时间戳
手续费金额	feeAmount	decimal(18,2)	O	手续费金额
手续费币种	feeCurrency	string(3)	O	手续费币种
实际入账金额	actualReceiveAmount	decimal(18,2)	M	实际入账金额
金额是否可用	availableFlag	string(1)	M	金额是否可用 0:不可用 1:可用
交易类型	receiveType	string(1)	M	交易类型 S:平台电商 D:独立站电商 T:线下一般货贸 F:服务贸易
汇款附言	tradeComments	string(1024)	O	汇款附言

返回示例:
{
  "list": [
    {
      "actualReceiveAmount": 1000,
      "availableFlag": "0",
      "feeAmount": 5,
      "feeCurrency": "USD",
      "flowNo": "62323082314263700034",
      "receiveAmount": 1000,
      "receiveCurrency": "IDR",
      "receiveTime": "1692772093",
      "receiveType": "S",
      "senderAccount": "",
      "senderName": "20230823002.ltd",
      "tradeComments": "",
      "vaAccount": "8808999911436641"
    }
  ]
}

5.3.5 贸易订单申请

1 功能描述

交易代码	TP1012
功能名称	商户创建贸易的订单合同
功能描述	收集订单信息
调用方式	实时接口
调用流程	商户发送申请，Easyloon返回合同订单号
应用场景	商户收集订单信息以及合规材料，提供商户新建贸易订单，并提供合同号

2 请求地址
Url： https://{baseUrl}/api/tp1012
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
回调接口地址	callbackUrl	string(60)	M	用来通知订单状态
商户唯一订单号	merOrderNo	string(32)	M	商户唯一订单号
订单币种	currency	string(3)	M	订单币种
订单总金额	amount	Decimal(18,2)	M	订单总金额
贸易类型	tradeType	string(2)	M	贸易类型默认：00-货物贸易 01-服务贸易
采购方名称	buyerName	string(64)	M	采购方名称
采购方所属地区	buyerArea	string(64)	M	采购方所属地区
物品信息	goodsList	List	M	物品信息物品数量不超过10个
交易日期	transcationDate	string(10)	M	交易日期格式：yyyy-MM-dd
交易凭证	transcationCert	Array	M	多个凭证文件地址数组 (文件大小不超过20M)
物流状态	logStatus	string(1)	O	当贸易类型为00-货物贸易时必填 0-未发货 1-已发货如果是已发货logNo、logCompany、annexUrl三个字段必填
物流单号	logNo	string(64)	O	物流单号
物流公司名称	logCompany	string(128)	O	物流公司名称
附件	annexUrl	Array	O	多个附件文件地址数组 (文件大小不超过20M)
服务贸易信息	serviceTrade	Object	O	当贸易类型为01-服务贸易时必填

goodsList

名称	Json标签	类型	属性	取值说明
交易物品名称	orderName	string(64)	M	交易物品名称
交易物品数量	orderNum	string(10)	M	交易物品数量

serviceTrade

名称	Json标签	类型	属性	取值说明
服务贸易状态	serviceCondition	string(1)	O	服务贸易完成状态 0-未完成 1-已完成
证明文件	proveUrl	Array	O	当服务贸易状态为1 此项必填
预计完成时间	conditionDate	string(10)	O	当服务贸易状态为0 此项必填格式 yyyy-MM-dd

请求示例:
{
  "amount": 8000,
  "buyerArea": "HK",
  "buyerName": "COMPANY LIMITED",
  "callbackUrl": "http://www.baidu.com",
  "currency": "USD",
  "goodsList": [
    {
      "orderName": "goodsName",
      "orderNum": "500"
    }
  ],
  "logCompany": "",
  "logNo": "",
  "logStatus": "0",
  "merOrderNo": "LNQ1692772694542",
  "serviceTrade": {
},
  "tradeType": "00",
  "transcationCert": [
    "uploadFile/test.pdf"
  ],
  "transcationDate": "2023-08-22"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
贸易订单号	contractNo	string(32)	M	贸易订单号（唯一）

响应示例:
    {
  "contractNo": "63733082314292600682"
}

5.3.6 贸易订单申请结果通知

1 功能描述

交易代码	TP2008
功能名称	回传贸易订单结果状态通知
功能描述	运营审核后通知商户订单申请结果
调用方式	通知接口
调用流程	--
应用场景	[5.1.13 贸易订单申请]发起成功，根据回调Url进行回调通知最终结果。

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。
商户应当自行通过 [5.3.4 贸易收款VA入账查询接口]查询交易结果。

2 请求地址
Url： [5.3.5 贸易订单申请]中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
贸易订单编号	contractNo	string(32)	M	贸易订单编号 (唯一)
商户订单号	merOrderNo	string(32)	M	商户订单号(唯一)
状态	status	string(8)	M	'ACCEPT-处理中 SUCC-成功 FAIL-失败'
结果描述	message	string(64)	M	交易结果描述

请求示例:
{
  "contractNo": "63823082314103100198",
  "merOrderNo": "LNQ1692772694542",
  "message": "成功",
  "status": "SUCC"
}

5.3.7 贸易订单申请信息查询

1 功能描述

交易代码	TP3013
功能名称	贸易合同结果信息查询
功能描述	提供商户查询贸易合同创建状态
调用方式	实时接口
调用流程	--
应用场景	商户需要查询订单合同的状态

2 请求地址
Url： https://{baseUrl}/api/tp3013
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long(13)	O	Unix10位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long(13)	O	Unxi10位时间戳，查询结束时间，闭区间
贸易合同号	contractNo	string(32)	O	[5.1.13 贸易订单申请]返回贸易合同号
订单号	merOrderNo	string(32)	O	商户提供的订单号

请求示例:
{
  "endTime": "1692806399",
  "startTime": "1692720000"
}

检查

startTime与endTime，间隔不能超过24小时。根据startTime和endTime的查询，最多显示100条。若startTime和endTime未填写，则contractNo为必填。

4 响应字段

名称	Json标签	类型	属性	取值说明
贸易订单	contractList	List	M	贸易订单集合

contractList

名称	Json标签	类型	属性	取值说明
商户唯一订单号	merOrderNo	string(32)	M	商户唯一订单号
订单币种	currency	string(3)	M	订单币种
订单总金额	amount	Decimal(18,2)	M	订单总金额
贸易类型	tradeType	string(2)	M	贸易类型默认：00-货物贸易
采购方名称	buyerName	string(64)	M	采购方名称
采购方所属地区	buyerArea	string(64)	M	采购方所属地区
物品信息	goodsList	List	M	物品信息物品数不超过10个
交易日期	transcationDate	string(10)	M	交易日期格式：yyyy-MM-dd
交易凭证	transcationCert	Array	M	多个凭证文件地址数组 (文件大小不超过20M)
物流状态	logStatus	string(1)	O	0-未发货 1-已发货
物流单号	logNo	string(64)	O	物流单号
物流公司名称	logCompany	string(64)	O	物流公司名称
物流附件	annexUrl	Array	O	物流附件 (文件大小不超过20M)
服务贸易信息	serviceTrade	Object	O	服务贸易信息
贸易订单号	contractNo	string(32)	M	贸易订单号（唯一）
贸易订单状态	status	string(8)	M	贸易订单状态 ACCEPT-处理中 SUCC-成功 FAIL-失败
查询结果描述	message	string(128)	M	查询结果描述

serviceTrade

名称	Json标签	类型	属性	取值说明
服务贸易状态	serviceCondition	string(1)	O	服务贸易完成状态 0-未完成 1-已完成
证明文件	proveUrl	Array	O	证明文件路径 serviceCondition 为0时必填
预计完成时间	conditionDate	string(10)	O	serviceCondition 为1时必填格式"yyyy-MM-dd"

响应示例:
{
  "contractList": [
    {
      "amount": 100,
      "annexUrl": [
        "app/test.png"
      ],
      "buyerArea": "HK",
      "buyerName": "COMPANY LIMITED",
      "callbackUrl": "https://www.baidu.com",
      "contractNo": "63823082314103100198",
      "currency": "USD",
      "goodList": [
        {
          "orderName": "goodsName",
          "orderNum": "500"
        }
      ],
      "logCompany": "",
      "logNo": "",
      "logStatus": "0",
      "merOrderNo": "LNQ1692772694542",
      "message": "成功",
      "serviceTrade": {
        "proveUrl": [
        ]
      },
      "status": "SUCC",
      "tradeType": "00",
      "transcationCert": [
        "app/test.pdf"
      ],
      "transcationDate": "2023-08-22"
    }
  ]
}

5.3.8 收款流水和贸易订单关联

1 功能描述

名称	Json标签
交易代码	TP1013
功能名称	收款流水和贸易订单关联
功能描述	收款流水和贸易订单关联
调用方式	实时接口
调用流程	--
应用场景	商户的贸易收款订单被审核通过后，将收款流水和贸易订单做关联

2 请求地址
Url： https://{baseUrl}/api/tp1013
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
贸易订单编码	contactNo	string(32)	M	贸易订单编码，tp2008返回
收款流水编码	flowNo	string(32)	M	收款流水编码，tp3015返回
入账通知地址	callbackUrl	string(255)	M	贸易收款入账成功后的通知地址

请求示例:
{
  "contactNo": "63291062211570000002",
  "flowNo": "62291060316483300005",
  "callbackUrl": "https://www.baidu.com"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
业务流水号	bizFlow	string(32)	M	BZcircle侧唯一业务订单号

返回示例:
{
  "bizFlow":"1143915555060752384"
}

5.3.9 收款流水和贸易订单关联结果通知

1 功能描述

交易代码	TP2009
功能名称	收款流水和贸易订单关联结果通知
功能描述	收款流水和贸易订单关联后，给商户发的通知
调用方式	通知接口
调用流程	--
应用场景	[5.3.8 收款流水和贸易订单关联]发起成功且交易处理完毕后，
	将根据[5.3.8 收款流水和贸易订单关联]参数内的回调Url进行回调通知最终结果。

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。
商户应当自行通过 [5.3.10 收款流水和贸易订单关联查询接口]查询接口查询交易结果。

2 请求地址
Url： [5.3.8 收款流水和贸易订单关联]中的 callbackUr
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
贸易订单编码	contactNo	string(32)	M	贸易订单编码
收款流水编码	flowNo	string(32)	M	收款流水编码
入账币种	currency	string	M	入账币种，3位标准货币代码
入账金额	amount	decimal(18,2)	M	收款金额
手续费币种	feeCurty	String	M	手续费币种，3位标准货币代码
手续费金额	feeAmt	decimal(18,2)	M	BZcircle收取手续费
入账时间	approveTime	bigInt(13)	M	入账时间戳(毫秒)
状态	status	string(2)	M	'02-通过 03-驳回'
结果描述	message	string(255)	M	交易结果描述

请求示例:
{
  "amount": 43444.8,
  "approveTime": 1692774260350,
  "bizFlow": "1143915555060752384",
  "contactNo": "63291062211570000002",
  "flowNo": "62291060316483300005",
  "currency": "CNY",
  "feeAmt": 130.33,
  "feeCurty": "CNY",
  "merchantNo": "004401100035",
  "message": "",
  "status": "02"
}

5.3.10 收款流水和贸易订单关联查询

1 功能描述

交易代码	TP3014
功能名称	收款流水和贸易订单关联查询接口
功能描述	提交收款流水和贸易订单关联申请后，通过此接口查询贸易收款是否入账
调用方式	实时接口
调用流程	--
应用场景	提交收款流水和贸易订单关联申请后（TP1013），通过此接口查询贸易收款是否入账
2 请求地址
Url： https://{baseUrl}/api/tp3014
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long(13)	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long(13)	O	Unxi13位时间戳，查询结束时间，闭区间
贸易订单编码	contactNo	string(32)	O	贸易订单编码，tp2008返回
收款流水编码	flowNo	string(32)	O	收款流水编码，tp3015返回
业务流水号	bizFlow	string(32)	O	BZcircle侧唯一业务订单号，tp1013返回

请求示例:
{
  "contactNo": "63291062211570000002",
  "flowNo": "62291060316483300005"
}

检查

若startTime与endTime，间隔不能超过24小时。根据startTime和endTime的查询，最多显示100条。

4 响应字段

名称	Json标签	类型	属性	取值说明
信息集合	relateList	List	M	--

ConfirmRelatetionReq 字段：

名称	Json标签	类型	属性	取值说明
贸易订单编码	contactNo	string(32)	M	贸易订单编码
收款流水编码	flowNo	string(32)	M	收款流水编码
入账币种	currency	string	M	入账币种，3位标准货币代码
入账金额	amount	decimal(18,2)	M	收款金额
手续费币种	feeCurty	String	M	手续费币种，3位标准货币代码
手续费金额	feeAmt	decimal(18,2)	O	BZcircle收取手续费
入账时间	approveTime	bigInt(13)	M	入账时间戳(毫秒)
状态	status	string(2)	M	'01-审核中 02-通过 03-驳回'
结果描述	message	string(64)	M	交易结果描述

返回示例:
{
  "relateList": [
    {
      "amount": 11197.08,
      "bizFlow": "1143915555060752384",
      "callbackUrl": "https://www.baidu.com",
      "contactNo": "63291062211570000002",
      "currency": "USD",
      "feeAmt": 0,
      "feeCurty": "USD",
      "flowNo": "62291060316483300005",
      "id": 5593,
      "merchantNo": "004401100035",
      "status": "01"
    }
  ]
}

5.3.11 电商订单申请

1 功能描述

交易代码	TP1016
功能名称	电商订单申请
功能描述	上传商户的电商类的收款的还原材料
调用方式	实时接口
调用流程	商户发送申请，BZcircle返回成功还是失败
应用场景	商户收款后上传电商类的订单信息以及合规材料
2 请求地址
Url： https://{baseUrl}/api/tp1016
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
还原材料集合	orderList	List	M	还原材料集合，1到500条数据内
交易类型	transType	string(1)	M	交易类型，暂时只支持 S:平台电商 D:独立站电商

orderList

名称	Json标签	类型	属性	取值说明
订单号	orderNo	string(32)	M	订单号
金额	amount	decimal(18,2)	M	金额，保留两位小数，大于0小于300000
币种	currency	string(3)	M	币种，3位标准货币代码
订单日期	dateTime	string(10)	M	订单日期，格式为yyyy-MM-dd
商品名称	commodity	string(512)	M	商品名称
商品数量	quantity	int	M	商品数量
物流公司名称	logisticsName	string(255)	M	物流公司名称
物流单号	logisticsNo	string(255)	M	物流单号
平台名称	platform	string(100)	M	平台名称
店铺Url	shopUrl	string(128)	M	店铺Url

请求示例:
{
  "orderList": [
    {
      "amount": 11000,
      "commodity": "时尚首饰",
      "currency": "USD",
      "dateTime": "2023-07-22",
      "logisticsName": "FedEx",
      "logisticsNo": "20230823001",
      "orderNo": "20230823001",
      "platform": "阿里巴巴",
      "purpose": "GOODSTRADE",
      "quantity": 30,
      "shopUrl": "https://www.baidu.com"
    }
  ],
  "transType": "S"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
返回接收状态	code	string(32)	M	返回接收状态

响应示例:
{
  "code": "success"
}

5.3.12 电商额度查询

1 功能描述

交易代码	TP3016
功能名称	电商额度查询
功能描述	查询商户当前可用的电商额度查询
调用方式	实时接口
调用流程	商户发送申请，Easyloon返回电商额度
应用场景	商户收款后或还原材料上传后，查询电商额度

2 请求地址
Url： https://{baseUrl}/api/tp3016
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
交易类型	transType	string(1)	M	交易类型，暂时只支持 S:平台电商 D:独立站电商

请求示例:
 {
  "transType": "D"
}

4 响应字段 | 名称 | Json标签 | 类型 | 属性 | 取值说明 | | --- | --- | --- | --- | --- | | 返回额度列表 | list | List | M | 返回额度列表 |

list

名称	Json标签	类型	属性	取值说明
可用余额	availableAmount	decimal(18,2)	M	可用余额
币种	currency	string(3)	M	币种，3位标准货币代码

响应示例:
{
  "list": [
    {
      "availableAmount": 1000.0,
      "currency": "CNY"
    }
  ]
}

5.3.13 VA开户结果通知

1 功能描述

交易代码	TP2012
功能名称	VA开户结果通知
功能描述	商户发起VA开户申请Easyloon审核后，通知商户VA开户的结果
调用方式	通知接口
调用流程	--
应用场景	[5.3.1 VA开户申请]发起成功且审核完毕后，将根据[5.3.1 VA开户申请]参数内的回调Url进行回调通知最终结果。

提示

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。
商户应当自行通过 [5.3.2 VA开户查询]查询接口查询申请结果。

2 请求地址
Url： [5.3.1 VA开户申请]中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	string(32)	O	商户唯一订单号
流水号	bizFlow	string(32)	O	流水号
VA账户名称	accountName	string(255)	O	VA账户名称
VA账户号	accountNo	string(64)	O	VA账户号
code信息	codeValue	string(16)	O	银行的Code
code名称	codeName	string(64)	O	ACH Routing Number，Bank Code，Sort Code，SWIFT CODE
银行名称	bankName	string(128)	O	银行名称
银行地址	bankAddress	string(255)	O	银行地址
国家/地区	area	string(64)	O	国家/地区
银行Code	bankCode	string(12)	O	银行Code
分行号	branchCode	string(12)	O	分行号
支持币种	currency	string(255)	O	支持币种，多币种之间按照
VA账户状态	status	string(8)	M	VA账户状态, ON:启用，OFF：禁用/拒绝 OPENING：开户中
备注	remark	string(8)	O	当为OFF时，会展示具体禁用/拒绝原因

请求示例:
{
  "accountName": "XDT-GUANGZHOU HELIBAO PAYMENT CO LTD",
  "accountNo": "8808999911436641",
  "area": "ID",
  "bankAddress": "Wisma BNI, Jakarta",
  "bankCode": "016",
  "bankName": "Bank Negara Indonesia（BNI）",
  "bizFlow": "80823082314163300199",
  "branchCode": "478",
  "codeName": "Bank Code",
  "codeValue": "0090081",
  "currency": "IDR",
  "merOrderNo": "LNQ1692771393185",
  "parentCode": "S",
  "remark": "",
  "status": "ON"
}

5.3.14 新增账户持有人

1 功能描述

交易代码	TP1024
功能名称	新增账户持有人
功能描述	新增账户持有人，为申请VA的持有人做准备。
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp1024
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
持有人类型	holderType	String(2)	M	持有人类型：00-个人，01-企业
持有人身份	holderIdentity	String(3)	M	持有人身份参数详见字段说明
其他持有人身份描述	otherTypeName	String(255)	C	其他持有人身份描述当持有人身份为其他时必传
身份证明文件	holderProveDocument	List	M	身份证明文件
持有人身份文件	holderCertificate	List	M	持有人身份文件
持有人英文名称	holderNameEn	String(255)	M	持有人英文名称
持有人中文名称	holderName	String(255)	C	持有人中文名称个人-注册地区为CN及HK时，必填企业-注册地区为CN时，必填
持有人所在地区	holderArea	String(2)	M	持有人所在国家/地区，传二字码
持有人证件类型	holderCertificateType	String(3)	M	持有人证件类型参数详见字段说明
持有人证件号	holderCertificateNumber	String(32)	M	持有人证件号
持有人地址	holderRealAddress	String(128)	M	持有人注册地址/持有人真实营业地址
持有人注册出生日期	holderRegistratDate	String(16)	M	持有人注册出生日期格式 yyyy-MM-dd
邮编	postalCode	String(32)	M	邮编
持有人性别	holderSex	String(2)	C	持有人性别 M:男 F:女个人必填
最终受益人信息	finalBeneficialReqs	List	C	最终受益人信息企业必填，最多5个
扩展字段	extensionField	List	O	扩展字段(其余扩展字段存放)
回调URL	callbackUrl	String(255)	M	回调URL

FinalBeneficialReq

名称	Json标签	类型	属性	取值说明
最终受益人名称	beneficialName	string(255)	M	最终受益人名称
最终受益人地区	beneficialArea	string(2)	M	最终受益人国家/地区
最终受益人证件类型	beneficialCertificateType	string(3)	M	最终受益人证件类型参数详见字段说明
最终受益人证件号码	beneficialCertificateNumber	string(32)	M	最终受益人证件号码
最终受益人出生日期	beneficialDate	string(16)	M	最终受益人出生日期格式 yyyy-MM-dd
最终受益人性别	beneficialSex	String(2)	M	最终受益人性别
备注	remark	string(255)	M	备注

请求示例:
{
  "holderType": "00",
  "holderCertificateType": "01",
  "callbackUrl": "https://www.baidu.com",
  "holderArea": "CN",
  "holderCertificate": [
    "uploadFile/dshjy.png"
  ],
  "holderCertificateNumber": "342211199101011111",
  "holderIdentity": "04",
  "holderName": "持有人",
  "holderNameEn": "chiyouren",
  "holderProveDocument": [
    "uploadFile/dshjy.png"
  ],
  "holderRealAddress": "上海外滩",
  "holderRegistratDate": "1991-07-08",
  "holderSex": "M",
  "postalCode": "10080"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
账户持有人状态	status	String(2)	M	账户持有人状态参数详见字段说明

返回示例:
{
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e",
    "status": "10"
  },
  "succ": true
}

5.3.15 修改账户持有人

1 功能描述

交易代码	TP1025
功能名称	修改账户持有人
功能描述	修改账户持有人，为申请VA的持有人做准备。仅限于持有人状态为拒绝的客户可传
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp1025
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
持有人类型	holderType	String(2)	M	持有人类型：00-个人，01-企业
持有人身份	holderIdentity	String(3)	M	持有人身份参数详见字段说明
其他持有人身份描述	otherTypeName	String(255)	C	其他持有人身份描述当持有人身份为其他时必传
身份证明文件	holderProveDocument	List	M	身份证明文件
持有人身份文件	holderCertificate	List	M	持有人身份文件
持有人英文名称	holderNameEn	String(255)	M	持有人英文名称
持有人中文名称	holderName	String(255)	C	持有人中文名称个人-注册地区为CN及HK时，必填企业-注册地区为CN时，必填
持有人所在地区	holderArea	String(2)	M	持有人所在国家/地区，传二字码
持有人证件类型	holderCertificateType	String(3)	M	持有人证件类型参数详见字段说明
持有人证件号	holderCertificateNumber	String(32)	M	持有人证件号
持有人地址	holderRealAddress	String(128)	M	持有人注册地址/持有人真实营业地址
持有人注册出生日期	holderRegistratDate	String(16)	M	持有人注册出生日期格式 yyyy-MM-dd
邮编	postalCode	String(32)	M	邮编
持有人性别	holderSex	String(2)	C	持有人性别 M:男 F:女个人必填
最终受益人信息	finalBeneficialReqs	List	C	最终受益人信息企业必填，最多5个
扩展字段	extensionField	List	O	扩展字段(其余扩展字段存放)
回调URL	callbackUrl	String(255)	M	回调URL

FinalBeneficialReq

名称	Json标签	类型	属性	取值说明
最终受益人名称	beneficialName	string(255)	M	最终受益人名称
最终受益人地区	beneficialArea	string(2)	M	最终受益人国家/地区
最终受益人证件类型	beneficialCertificateType	string(3)	M	最终受益人证件类型参数详见字段说明
最终受益人证件号码	beneficialCertificateNumber	string(32)	M	最终受益人证件号码
最终受益人出生日期	beneficialDate	string(16)	M	最终受益人出生日期格式 yyyy-MM-dd
最终受益人性别	beneficialSex	String(2)	M	最终受益人性别
备注	remark	string(255)	M	备注

请求示例:
{
  "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e",
  "holderType": "00",
  "holderCertificateType": "01",
  "callbackUrl": "https://www.baidu.com",
  "holderArea": "CN",
  "holderCertificate": [
    "uploadFile/dshjy.png"
  ],
  "holderCertificateNumber": "342211199101011111",
  "holderIdentity": "04",
  "holderName": "持有人",
  "holderNameEn": "chiyouren",
  "holderProveDocument": [
    "uploadFile/dshjy.png"
  ],
  "holderRealAddress": "上海外滩",
  "holderRegistratDate": "1991-07-08",
  "holderSex": "M",
  "postalCode": "10080"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
账户持有人状态	status	String(2)	M	账户持有人状态参数详见字段说明

返回示例:
{
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e",
    "status": "10"
  },
  "succ": true
}

5.3.16 账户持有人补充信息

1 功能描述

交易代码	TP1026
功能名称	账户持有人补充信息
功能描述	账户持有人补充信息，为申请VA的持有人做准备。仅限于持有人状态为待补充信息和补充审核拒绝的客户可传，字段仅可传查询接口获取的待补充字段
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp1026
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
持有人类型	holderType	String(2)	C	持有人类型：00-个人，01-企业
持有人身份	holderIdentity	String(3)	C	持有人身份参数详见字段说明
其他持有人身份描述	otherTypeName	String(255)	C	其他持有人身份描述当持有人身份为其他时必传
身份证明文件	holderProveDocument	List	C	身份证明文件
持有人身份文件	holderCertificate	List	C	持有人身份文件
持有人英文名称	holderNameEn	String(255)	C	持有人英文名称
持有人中文名称	holderName	String(255)	C	持有人中文名称个人-注册地区为CN及HK时，必填企业-注册地区为CN时，必填
持有人所在地区	holderArea	String(2)	C	持有人所在国家/地区，传二字码
持有人证件类型	holderCertificateType	String(3)	C	持有人证件类型参数详见字段说明
持有人证件号	holderCertificateNumber	String(32)	C	持有人证件号
持有人地址	holderRealAddress	String(128)	C	持有人注册地址/持有人真实营业地址
持有人注册出生日期	holderRegistratDate	String(16)	C	持有人注册出生日期格式 yyyy-MM-dd
邮编	postalCode	String(32)	C	邮编
持有人性别	holderSex	String(2)	C	持有人性别 M:男 F:女个人必填
回调URL	callbackUrl	String(255)	C	回调URL

请求示例:
{
  "holderId": "51f29956-e603-43ff-ab59-2e681be2ef93",
  "holderType": "01",
  "holderIdentity": "11",
  "holderProveDocument": [
    "uploadFile/dszj.jpg"
  ],
  "holderNameEn": "qiye",
  "holderName": "企业",
  "otherTypeName": "代理",
  "holderArea": "CN",
  "holderCertificateType": "03",
  "holderCertificateNumber": "9023546645481",
  "holderRealAddress": "上海",
  "holderRegistratDate": "2022-02-27",
  "callbackUrl": "http://."
}

4 响应字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
账户持有人状态	status	String(2)	M	账户持有人状态参数详见字段说明

返回示例:
{
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "holderId": "51f29956-e603-43ff-ab59-2e681be2ef93",
    "status": "10"
  },
  "succ": true
}

5.3.17 账户持有人查询

1 功能描述

交易代码	TP3018
功能名称	账户持有人查询
功能描述	查询账户持有人信息
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp3018
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	O	账户持有人ID 持有人唯一ID
持有人英文名称	holderNameEn	String(255)	O	持有人英文名称
持有人证件号	holderCertificateNumber	String(32)	O	持有人证件号
查询起始时间	startTime	Long(13)	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long(13)	O	Unix13位时间戳，查询结束时间，闭区间
页数	pageNo	Int	O	分页页数，默认1
页显示数	pageSize	Int	O	分页页显示数，默认10，最大100

请求示例:
{
  "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
持有人类型	holderType	String(2)	M	持有人类型：00-个人，01-企业
持有人身份	holderIdentity	String(3)	M	持有人身份参数详见字段说明
持有人英文名称	holderNameEn	String(255)	M	持有人英文名称
持有人所在地区	holderArea	String(2)	M	持有人所在国家/地区，传二字码
持有人证件类型	holderCertificateType	String(3)	M	持有人证件类型参数详见字段说明
持有人证件号	holderCertificateNumber	String(32)	M	持有人证件号
持有人注册出生日期	holderRegistratDate	String(16)	M	持有人注册出生日期格式 yyyy-MM-dd
账户持有人状态	status	String(2)	M	账户持有人状态参数详见字段说明
结果描述	resMessage	String(255)	O	审核结果描述
待补充字段	replenishField	List	C	待补充字段(状态为待补充材料和待补充审核拒绝存在)

返回示例:
{
  "list": [
    {
      "holderArea": "CN",
      "holderCertificateNumber": "342211199101011111",
      "holderCertificateType": "01",
      "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e",
      "holderIdentity": "04",
      "holderNameEn": "chiyouren",
      "holderRegistratDate": "1991-07-08",
      "holderType": "00",
      "id": 21174,
      "resMessage": "",
      "status": "10"
    }
  ],
  "pageNum": 1,
  "pageSize": 10,
  "pages": 1,
  "prePage": 0,
  "size": 1,
  "startRow": 1,
  "total": 1
}

5.3.18 账户持有人审核结果通知

1 功能描述

交易代码	TP2013
功能名称	账户持有人审核结果通知
功能描述	账户持有人审核结果通知
调用方式	实时接口
调用流程	---
应用场景	在商户的账户持有人信息审核成功后，BZcircle会向商户发送账户持有人审核结果通知

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址
Url：【待补充】callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
账户持有人ID	holderId	String(64)	M	账户持有人ID 持有人唯一ID
持有人类型	holderType	String(2)	M	持有人类型：00-个人，01-企业
持有人身份	holderIdentity	String(3)	M	持有人身份参数详见字段说明
持有人英文名称	holderNameEn	String(255)	M	持有人英文名称
持有人所在地区	holderArea	String(2)	M	持有人所在国家/地区，传二字码
持有人证件类型	holderCertificateType	String(3)	M	持有人证件类型参数详见字段说明
持有人证件号	holderCertificateNumber	String(32)	M	持有人证件号
持有人注册出生日期	holderRegistratDate	String(16)	M	持有人注册出生日期格式 yyyy-MM-dd
账户持有人状态	status	String(2)	M	账户持有人状态参数详见字段说明
结果描述	resMessage	String(255)	O	审核结果描述

请求示例:
{
  "holderArea": "CN",
  "holderCertificateNumber": "342211199101011111",
  "holderCertificateType": "01",
  "holderId": "7be43506-35b5-4c53-b0ec-687526cfe45e",
  "holderIdentity": "04",
  "holderNameEn": "chiyouren",
  "holderRegistratDate": "1991-07-08",
  "holderType": "00",
  "id": 0,
  "resMessage": "信息有误",
  "status": "20"
}

5.4 换汇

5.4.1 牌价查询

1 功能描述

交易代码	TP1002
功能名称	牌价查询
功能描述	查询某币种的FX牌价
调用方式	实时接口
调用流程	--
应用场景	在进行FX交易前，需要先询价

2 请求地址
Url： https://{baseUrl}/api/tp1002
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	String(32)	M	商户自定义的唯一订单号
卖出币种	sellCurrency	String(3)	O	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
锁定方向	lockDirection	String(4)	M	锁定卖出或买入币种;传SELL则锁定卖出币种的金额，传BUY则锁定买入币种的金额
锁定金额	amount	String(20)	M	指定的FX金额注：您申请的换汇金额等值不足100USD，可能导致换汇失败
锁汇类型	lockType	String(2)	O	选填字段：目前支持可选T0、T1,当不传时，即为实时换汇

请求示例:
{
  "amount": "1",
  "buyCurrency": "HKD",
  "lockDirection": "SELL",
  "merOrderNo": "LNQ1692790975123",
  "sellCurrency": "USD"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
汇率	rate	String(18)	M	汇率报价
卖出金额	sellAmount	String(18)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
报价ID	quoteId	Long	M	报价ID
报价有效期	expireTime	Long	M	unix时间戳，此次询价的有效时间。如若过了有效时间，此次询价作废
商户订单号	merOrderNo	String(32)	M	商户传入的订单号
锁汇类型	lockType	String(2)	O	锁汇类型 T0、T1,当不传时，即为实时换汇

返回示例:
{
  "buyAmount": "7.84",
  "buyCurrency": "HKD",
  "expireTime": 1692790988000,
  "merOrderNo": "LNQ1692790975123",
  "quoteId": 1143993799583002600,
  "rate": "7.8400000000",
  "sellAmount": "1",
  "sellCurrency": "USD"
}

5.4.2 FX交易

1 功能描述

交易代码	TP1003
功能名称	FX交易
功能描述	根据询价后的牌价，发起FX交易
调用方式	实时接口
调用流程	在发起牌价查询接口后，根据所得到的quoteId，发起相应的FX交易
应用场景	--

2 请求地址
Url： https://{baseUrl}/api/tp1003
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	Long	M	报价ID
回调url	callbackUrl	String(256)	M	回调通知Url

请求示例:
{
  "callbackUrl": "https://www.baidu.com",
  "quoteId": 1143993799583002600
}

4 响应字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
汇率	rate	String(18)	M	汇率报价
卖出金额	sellAmount	String(18)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
报价ID	quoteId	Long	M	报价ID
结果码	code	String	M	Fx交易结果码
结果描述	message	String	M	交易结果描述
交易流水号	bizFlow	String(32)	M	对应Fx交易的唯一流水号
锁汇类型	lockType	String(2)	O	锁汇类型 T0、T1

返回示例:
{
  "bizFlow": "21823082319430400222",
  "buyAmount": "7.84",
  "buyCurrency": "HKD",
  "code": "S00001",
  "message": "Processing",
  "quoteId": 1143993799583002600,
  "rate": "7.8400000000",
  "sellAmount": "1.00",
  "sellCurrency": "USD"
}
返回示例:
{
  "bizFlow": "21823082319430400222",
  "buyAmount": "7.84",
  "buyCurrency": "HKD",
  "code": "S00001",
  "message": "Processing",
  "quoteId": 1143993799583002600,
  "rate": "7.8400000000",
  "sellAmount": "1.00",
  "sellCurrency": "USD"
}

5.4.3 换汇历史交易查询

1 功能描述

交易代码	TP3003
功能名称	换汇历史交易查询
功能描述	换汇历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的换汇历史交易

2 请求地址
Url： https://{baseUrl}/api/tp3003
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long	O	Unxi13位时间戳，查询结束时间，闭区间
报价ID	quoteId	Long	O	报价ID

请求示例:
{
  "endTime": 1692806399000,
  "startTime": 1692720000000
}

说明：若startTime与endTime没填，则quoteId为必填。若quoteId没填，则startTime与endTime为必填，且间隔不能超过24小时。

4 响应字段
接口返回对象为: List
ExchangeHistory 字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
汇率	rate	String(18)	M	汇率报价
卖出金额	sellAmount	String(20)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
报价ID	quoteId	Int	M	报价ID
结果码	code	String	M	Fx交易结果码 S00000-成功 S00001-处理中 S00002-待生效 S00003-已取消 S00004-已过期其余暂为失败
结果描述	message	String	M	交易结果描述
业务流水号	bizFlow	String(32)	M	对应唯一业务流水号

请求示例:
{
  "list": [
    {
      "bizFlow": "21823082319430400222",
      "buyAmount": "7.84",
      "buyCurrency": "HKD",
      "code": "S00000",
      "message": "Success",
      "quoteId": 1143993799583002600,
      "rate": "7.8400000000",
      "sellAmount": "1.00",
      "sellCurrency": "USD"
    }
  ]
}

5.4.4 FX交易结果通知

1 功能描述

交易代码	TP2002
功能名称	FX交易结果通知
功能描述	Fx的交易结果异步通知
调用方式	通知接口
调用流程	--
应用场景	5.4.2 Fx交易发起成功且交易处理完毕后，将根据5.4.2 Fx交易参数内的回调Url进行回调通知最终结果。

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。
商户应当自行通过 5.4.3 换汇历史交易查询查询接口查询交易结果。

2 请求地址
Url： 5.4.2 Fx交易中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
汇率	rate	String(18)	M	汇率报价
卖出金额	sellAmount	String(20)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
报价ID	quoteId	Long	M	报价ID
结果码	code	String	M	Fx交易结果码 S00000-成功 S00001-处理中 S00002-待生效 S00003-已取消 S00004-已过期其余暂为失败
结果描述	message	String	M	交易结果描述
业务流水号	bizFlow	String(32)	M	业务流水号

请求示例:
 {
  "bizFlow": "21823082319430400222",
  "buyAmount": "7.84",
  "buyCurrency": "HKD",
  "code": "S00000",
  "message": "Success",
  "quoteId": 1143993799583002600,
  "rate": "7.8400000000",
  "sellAmount": "1.00",
  "sellCurrency": "USD"
}

5.4.5 查询支持换汇币种对

1 功能描述

交易代码	TP3002
功能名称	查询换汇支持币种对
功能描述	查询换汇支持币种对，可在当前支持的币种内进行FX交易
调用方式	实时接口
调用流程	--
应用场景	需要查询目前已支持的FX币种

2 请求地址
Url： https://{baseUrl}/api/tp3002
Method： POST
3 请求字段
无
4 响应字段
接口返回对象为: List
CurrencyPair字段：

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种

响应示例:
 {
  "list": [
    {
      "buyCurrency": "CHF",
      "sellCurrency": "NOK"
    },
    {
      "buyCurrency": "AUD",
      "sellCurrency": "CHF"
    }
  ]
}

5.4.6 委托换汇提交申请

1 功能描述

交易代码	TP1027
功能名称	委托换汇申请提交
功能描述	指定委托汇率，交易申请提交
调用方式	实时接口
调用流程	--
应用场景	需要委托换汇，按照指定汇率进行交割的换汇场景

2 请求地址
Url： https://{baseUrl}/api/tp1027
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
委托汇率	entrustRate	String(18)	M	委托汇率
卖出金额	sellAmount	String(20)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
锁定方向	lockDirection	String(4)	M	锁定卖出或买入币种;传SELL则锁定卖出币种的金额，传BUY则锁定买入币种的金额
截止日期	deadLineDate	String(20)	M	截止日期：格式：yyyy-MM-dd
回调通知地址	callbackUrl	String(256)	M	回调通知地址

请求示例:
 {
     "callbackUrl": "http://www.baidu.com",
     "merOrderNo": "12345678116",
     "sellCurrency": "USD",
     "buyCurrency": "CNY",
     "lockDirection": "SELL",
     "sellAmount": "10",
     "buyAmount": "72",
     "entrustRate": "7.2",
     "deadLineDate": "2023-08-29"
 }

4 响应字段

名称	Json标签	类型	属性	取值说明
卖出币种	sellCurrency	String(3)	M	卖出币种
买入币种	buyCurrency	String(3)	M	买入币种
委托汇率	entrustRate	String(18)	M	委托汇率
卖出金额	sellAmount	String(20)	M	卖出金额
买入金额	buyAmount	String(20)	M	买入金额
结果码	code	String	M	交易结果码
结果描述	message	String	M	交易结果描述
业务流水号	bizFlow	String(32)	M	业务流水号
换汇类型	lockType	String(20)	M	换汇类型：委托换汇（ENTRUST_EXCHANGE）

响应示例:
{
    "sellCurrency": "USD",
    "buyCurrency": "CNY",
    "entrustRate": "7.2",
    "sellAmount": "10",
    "buyAmount": "72",
    "code": "S00001",
    "message": "Processing",
    "bizFlow": "21803082911294500002",
    "lockType": "ENTRUST_EXCHANGE"
}

5.4.7 委托换汇申请取消

1 功能描述

交易代码	TP1028
功能名称	委托换汇申请取消
功能描述	指定委托汇率，交易申请取消
调用方式	实时接口
调用流程	--
应用场景	委托换汇，按照指定汇率进行交割前的申请取消
2 请求地址
Url： https://{baseUrl}/api/tp1028
Method： POST
3 请求字段
名称	Json标签
---	---
业务流水号	bizFlow

请求示例:
{
    "bizFlow": "21733082910452000003"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
结果码	code	String	M	交易结果码
结果描述	message	String	M	交易结果描述
业务流水号	bizFlow	String(32)	M	业务流水号

响应示例:
{
    "code": "S00000",
    "message": "S00000",
    "bizFlow": "21733082910452000003"
}

5.5 人民币付款

5.5.1 人民币付款

1 功能描述

交易代码	TP1001
功能名称	人民币付款
功能描述	发起人民币付款请求，将收款人信息发送至Easyloon
调用方式	实时接口
调用流程	先通过sftp将还原材料提交至Easyloon，再调用此接口发送付款信息
应用场景	需要将人民币付给国内持卡人
2 请求地址
Url： https://{baseUrl}/api/tp1001
Method： POST
3 请求字段
名称	Json标签
---	---
订单号	merOrderNo
还原材料路径	fileUrlPath
交易类型	paymentType
结汇类型	settlementType
回调地址	callbackUrl
收款人列表	payOrderList
还原材料列表	payReduceList

PayOrderRequest信息

名称	Json标签	类型	属性	取值说明
单笔订单号	merSingleNo	String	O	单个付款记录对应的订单号
收款方账号	payeeAccountNo	String	M	收款方银行账号
收款方姓名	payeeName	String	M	收款方银行账户名
身份证号/统一社会信用代码	identity	String	M	若收款方账户类型为0，则填写身份证号，为1则填写统一社会信用代码
金额	amount	Decimal	C	付款金额，单位为分，例：若付款200.00元，应填写20000最小为1，和debitAmount强制2选1
扣款币种	debitCurrency	String	O	扣款币种,默认为CNY (如果入参存在并且不为CNY，则返回后需调用确认接口) (批次内仅允许选择一种币种)
扣款金额	debitAmount	Decimal	C	扣款金额，单位为分，例：若付款200.00元，应填写20000最小为1，和amount强制2选1
联行号	cNAPSCode	String	C	收款方银行联行号企业必填，个人非必填
手机号	mobile	String	M	手机号
交易编码	tradeCodeType	String	M	参数详见字段说明
付款方式	payMethod	String	O	参数详见字段说明,
				tradeCodeType为TRADE并且paymentType为B2B时不能为空,
				默认：cash_on_delivery
报关币种	declarationCurrency	String	O	payMethod值为cash_on_delivery不能为空，默认CNY
预付比例	advanceProportion	Float	O	payMethod值为advance ,0 < advanceProportion < 1 ,小数点后最多两位
结算账期	settlementDate	String	O	payMethod值为advance结算账期不能为空单位天
付款方名称	senderName	String	M	真实付款方名称
付款方公司注册号	senderIncorporationNo	String	M	付款方公司注册号
付款方注册地	registrationRegion	String	M	付款人住的区域swift国家地区
付款方银行名称	senderBankName	String	M	付款方银行名称
资金源	sourceFounds	String	O	选填
付款方银行账户	senderBankAccountNo	String	O	付款方银行账户选填
汇款附言	tradeComments	string(1024)	O	汇款附言

payReduceList信息

名称	Json标签	类型	属性	取值说明
订单号	orderNo	String	M	单个付款记录对应的订单号(不超过32位)
订单币种	orderCurrency	String	M	收款币种
订单金额	orderAmount	Decimal	M	收款金额，单位为分，例：若付款200.00元，应填写20000最小为1
订单日期	orderDate	String	M	收款日期，格式为"yyyy-MM-dd"
收款人姓名	sellerName	String	C	收款人姓名 (交易编码为游戏或者一般货物贸易-网络购物(批次内多个收款人下发)时必填)
收款人证件号	sellerId	String	C	收款方证件号(长度不超过18位)(交易编码为游戏或者一般货物贸易-网络购物(批次内多个收款人下发)时必填)
商品名	goodsName	String	M	商品名 (4~512长度)
商品种类	goodsCategory	String	C	商品种类 (交易编码为游戏时必填)
商品数量	goodNumber	String	M	商品数量
物流公司	wlName	String	C	物流公司名 (交易编码为一般货物贸易-网络购物或者电商时必填)
物流单号	wlSeqno	String	C	物流单号 (交易编码为一般货物贸易-网络购物或者电商时必填)
店铺链接	storeLink	String	C	店铺链接地址 (交易编码为一般货物贸易-网络购物或者电商时必填)
平台名称	platformName	String	C	平台名称 (交易编码为一般货物贸易-网络购物或者电商时必填)
汇款用途	purpose	String	C	汇款用途代码参数 (交易编码为一般货物贸易-网络购物或者电商时必填)
买家银行名	buyerBankName	String	O	买家银行名
买家银行卡号	buyerBankCard	String	O	买家银行卡号
交易方式	sendType	String	O	发货方式
快递金额	sendAmount	Decimal	O	快递金额，单位为分，例：若付款200.00元，应填写20000最小为1
税费金额	taxAmount	Decimal	O	税费金额，单位为分，例：若付款200.00元，应填写20000最小为1
其他金额	otherAmount	Decimal	O	其他金额，单位为分，例：若付款200.00元，应填写20000最小为1
申报人类型	applyType	String	O	申报人类型
收款人账号	payeeAcctNo	String	C	收款人账号 (一般货物贸易-网络购物(批次内多个收款人下发)时必填)

返回示例:
{
  "amount": 20000,
  "bizFlowNo": "31733082318111101613",
  "debitAmount": 20000,
  "debitCurrency": "CNY",
  "merOrderNo": "LNQ004401100035001",
  "rate": 1,
  "status": "3"
}

4 响应字段
若响应报文头内respCode为S00000，则为受理成功，请等待异步通知（见5.5.3 系统通知商户付款结果）付款结果。报文体：当 respCode为S00000时：

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	String(32)	M	原样返回
业务流水号	bizFlowNo	String(32)	M	BZcircle生成的唯一业务流水号，与订单号一一对应
状态	status	String(1)	M	"0":"接受", "1":"成功", "2":"失败", "3":"处理中", "6":"待确认"
手续费币种	feeCurrency	String(3)	O	所收取的手续费币种
手续费币种	feeAmount	Decimal	O	所收取的手续费金额
实际付款金额	actualPayAmount	Decimal	O	实际付款金额
扣款币种	debitCurrency	String	M	扣款币种
汇率	rate	Decimal	O	汇率
扣款金额	debitAmount	Decimal	M	扣款金额
收款金额	amount	Decimal	M	收款金额
报价ID	quoteId	long	O	报价ID
报价有效期	expireTime	long	O	unix时间戳，此次询价的有效时间。

返回示例::
{
  "amount": 20000,
  "bizFlowNo": "31733082318111101613",
  "debitAmount": 20000,
  "debitCurrency": "CNY",
  "merOrderNo": "LNQ004401100035001",
  "rate": 1,
  "status": "3"
}

5.5.2 人民币付款业务查询

1 功能描述

交易代码	TP3001
功能名称	人民币付款业务查询
功能描述	商户自行查询人民币付款最终结果
调用方式	实时接口
调用流程	商户发送人民币付款请求后，查询对应订单结果
应用场景	商户需要知晓人民币付款最终结果

2 请求地址
Url： https://{baseUrl}/api/tp3001
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	String(32)	O	付款发起时的订单号
业务流水号	bizFlowNo	String(32)	O	BZcircle生成的唯一业务流水号，与订单号一一对应注：订单号与业务流水号仅需填写一个，若同时填写，以业务流水号为准

请求示例:
{
  "bizFlowNo":"31183081711294000016"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	String(32)	M	付款请求发起时的订单号
业务流水号	bizFlowNo	String(32)	M	付款请求返回的业务流水号
状态	status	String(1)	M	"0":"接受", "1":"成功", "2":"失败", "3":"处理中", "6":"待确认"
结果代码	respCode	String(6)	M	付款交易结果代码
结果描述	respDesc	String(50)	M	付款交易结果详情描述
收款人列表	payeeList	List	M	收款人列表
手续费币种	feeCurrency	String(3)	O	所收取的手续费币种
手续费币种	feeAmount	Decimal	O	所收取的手续费金额
实际付款金额	actualPayAmount	Decimal	O	实际付款金额
结汇类型	settlementType	String(3)	O	10极速结汇，00普通结汇，若不填则默认00普通结汇
扣款币种	debitCurrency	String	M	扣款币种
扣款金额	debitAmount	Decimal	M	扣款金额
收款金额	amount	Decimal	M	收款金额
汇率	rate	Decimal	O	汇率

payee 的字段

名称	Json标签	类型	属性	取值说明
单笔订单号	merSingleNo	String(32)	M	单个付款记录对应的订单号
收款方户名	payeeName	String(64)	M	收款方银行账户户名
收款方账号	payeeAccountNo	String(32)	M	收款方银行账号
收款方账户类型	acctType	String(1)	M	0 : 对私账户 1：对公账户
身份证号/	identity	String(32)	M	若收款方账户类型为 0，则填写身份证号，
统一社会信用代码				为 1 则填写统一社会信用代码
金额	amount	String(18)	M	付款金额，单位为分，例：若付款 200.00 元，应填写 20000
扣款金额	debitAmount	String(18)	M	扣款金额，单位为分，例：若付款 200.00 元，应填写 20000
联行号	cNAPSCode	String(64)	M	联行号
手机号	mobile	String(13)	M	手机号
开户行名称	bankName	String(32)	M	收款方银行名称
开户行省份	bankProvince	String(32)	M	收款方银行所在省份
开户行市名	bankCity	String(32)	M	收款方银行所在市名
支行名称	bankBranchName	String(32)	M	收款方银行支行名称
交易编码	tradeCodeType	String(6)	M	对应交易属性类型，参见参数详见字段说明
单笔结果代码	respCode	String(6)	M	单笔交易对应的结果代码
单笔结果描述	respDesc	String(50)	M	单笔交易对应的结果描述
付款方式	payMethod	String	F	tradeCodeType为 TRADE，并且 paymentType 为 B2B 时不能为空
				参数详见字段说明
报关币种	declarationCurrency	String	F	payMethod 值为 cash_on_delivery 不能为空
预付比例	advanceProportion	Float	F	payMethod 值为 advanc
				0 < advanceProportion < 1 小数点后最多两位
结算账期	settlementDate	String	F	payMethod 值为 advance
				结算账期不能为空单位天
付款方名称	senderName	String	M	真实付款方名称
付款方公司注册号	senderIncorporationNo	String	M	付款方公司注册号
付款方注册地	registrationRegion	String	M	付款人住的区域 swift 国家地区
付款方银行名称	senderBankName	String	M	付款方银行名称
资金源	sourceFounds	String	F	选填
付款方银行账户	senderBankAccountNo	String	F	付款方银行账户选填

请求示例:
{
  "actualPayAmount": 35900,
  "amount": 35900,
  "bizFlowNo": "31183081711294000016",
  "debitAmount": 35900,
  "debitCurrency": "CNY",
  "feeAmount": 600,
  "feeCurrency": "CNY",
  "merOrderNo": "LNQ202308230001",
  "merchantNo": "004401100035",
  "payeeList": [
    {
      "acctType": "1",
      "amount": 35900,
      "applyNo": "32183081711294000017",
      "bankBranchName": "中国工商银行",
      "bankCity": "654300",
      "bankName": "中国工商银行",
      "bankProvince": "650000",
      "debitAmount": 35900,
      "identity": "450923199201011113",
      "merSingleNo": "LNQ202308230001_0001",
      "mobile": "13212345678",
      "payeeAccountNo": "6226151810004564",
      "payeeName": "VKB",
      "status": "3",
      "tradeCodeType": "TRADE",
      "tradeComments": "fuyan"
    }
  ],
  "rate": 1,
  "settlementType": "00",
  "status": "3"
}

5.5.3 系统通知商户付款结果

1 功能描述

交易代码	TP2001
功能名称	付款回调
功能描述	Easyloon 通知商户付款结果
调用方式	实时接口
调用流程	商户先调用 5.5.1 人民币付款向 Easyloon 发起人民币付款请求，Easyloon 将交易。
	处理完毕后，通知商户。若规定时间内未及时回调通知商户，商户应该发起主动查询
应用场景	商户需要知晓人民币付款最终结果

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。
商户应当自行通过 5.5.2 人民币付款业务查询查询接口查询交易结果。

2 请求地址
Url： 5.1.1 人民币付款中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
订单号	merOrderNo	String(32)	M	原样返回
业务流水号	bizFlowNo	String(32)	M	BZcircle生成的唯一业务流水号，与订单号一一对应
成功笔数	successCount	Int	M	返回成功笔数
失败笔数	faultCount	Int	M	返回失败笔数
付款详情	payeeList	List	M	付款详情列表不分页
结汇类型	settlementType	String(3)	O	10极速结汇，00普通结汇，若不填则默认00普通结汇
扣款币种	debitCurrency	String	M	扣款币种
扣款金额	debitAmount	Decimal	M	扣款金额
收款金额	amount	Decimal	M	收款金额
汇率	rate	Decimal	O	汇率

payee 字段:

名称	Json标签	类型	属性	取值说明
单笔详情外部商户号	merSingleNo	String	M	商户传入的管理商户系统的凭证号
系统订单号	applyNo	String		BZcircle 生成的订单号
金额	amount	Decimal(18,2)	M	付款金额
扣款金额	debitAmount	Decimal(18,2)	M	扣款金额
状态	status	Int	M	"0":"接受","1", "成功","2","失败","3","处理中"
说明	respDesc	String	M	交易具体说明
状态码	respCode	String	M	交易具体的状态码

请求示例:
{
  "amount": 35900,
  "bizFlowNo": "31183081711294000016",
  "debitAmount": 35900,
  "debitCurrency": "CNY",
  "faultCount": 0,
  "merOrderNo": "LNQ202308230001",
  "payeeList": [
      {
          "amount": 35900,
          "applyNo": "32183081711294000017",
          "debitAmount": 35900,
          "merSingleNo": "LNQ202308230001_0001",
          "respCode": "00000",
          "respDesc": "成功",
          "status": "1"
      }
  ],
  "rate": 1,
  "settlementType": "00",
  "successCount": 1
}

5.5.4 查询总行

1 功能描述

交易代码	TP6001
功能名称	总行查询
功能描述	分页查询总行信息接口
调用方式	实时接口
调用流程	--
应用场景	当前账户余额查询

2 请求地址
Url： https://{baseUrl}/api/tp6001
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
页数	pageNo	Int	O	分页页数，默认1
页显示数	pageSize	Int	O	页显示数，默认10

请求示例:
{
  "pageNo": 1,
  "pageSize": 2
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页数	pageNo	Int	M	--
当前页显示数	pageSize	Int	M	--
总记录数	totalRecord	Int	M	--
总行信息集合	results	List	M	--

QueryBankResp 字段：

名称	Json标签	类型	属性	取值说明
银行名称	bankName	String(64)	M	--
银行Id	bankId	int	M	--
银行名称英文	bankNameEn	String(64)	M	--

返回示例:
{
  "pageNo": 1,
  "pageSize": 2,
  "results": [
    {
      "bankId": 1,
      "bankLinkNo": "102100099996",
      "bankName": "中国工商银行总行清算中心"
    },
    {
      "bankId": 2,
      "bankLinkNo": "103100000026",
      "bankName": "中国农业银行资金清算中心"
    }
  ],
  "totalPage": 2,
  "totalRecord": 20
}

5.5.5 查询总行下分行支持省份

1 功能描述

交易代码	TP6002
功能名称	查询省份信息
功能描述	查询总行下支持分行所在省份
调用方式	实时接口
调用流程	--
应用场景	--

2 请求地址
Url： https://{baseUrl}/api/tp6002
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
总行Id	bankId	Int	M	必填总行的银行编码

请求示例:
{
  "bankId":"1"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
总行Id	bankId	Int	M	总行的银行编码
省份信息集合	provinceList	List	M	--

ProvinceResp 字段：

名称	Json标签	类型	属性	取值说明
省份编码	provinceCode	String(64)	M	--
省份名称	provinceName	String(32)	M	--
省份名称英文	provinceNameEn	String(64)	M	--

返回示例:
{
  "bankId": 1,
  "provinceList": [
    {
      "provinceCode": "11",
      "provinceName": "北京市",
      "provinceNameEn": "Beijing"
    },
    {
      "provinceCode": "12",
      "provinceName": "天津市",
      "provinceNameEn": "Tianjin"
    }
  ]
}

5.5.6 查询总行下分行支持城市

1 功能描述

交易代码	TP6003
功能名称	查询城市信息
功能描述	查询总行下支持分行所在城市
调用方式	实时接口
调用流程	--
应用场景	--

2 请求地址
Url： https://{baseUrl}/api/tp6003
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
总行Id	bankId	Int	M	必填总行的银行编码
省份编码	provinceCode	String(64)	M	必填省份编码

请求示例:
{
    "bankId": "1",
    "provinceCode": "11"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
总行Id	bankId	Int	M	--
省份编码	provinceCode	String(64)	M	--
城市信息集合	cityList	List	M	--

CityResp 字段

名称	Json标签	类型	属性	取值说明
城市编码	cityCode	String(64)	M	--
城市名称	cityName	String(32)	M	--
城市名称英文	cityNameEn	String(32)	M	--

返回示例:
{
  "bankId": 1,
  "cityList": [
    {
      "cityCode": "1101",
      "cityName": "北京市",
      "cityNameEn": "City area"
    }
  ],
  "provinceCode": "11"
}

5.5.7 查询总行下某城市所有分行

1 功能描述

交易代码	TP6004
功能名称	查询分行信息
功能描述	查询总行下某城市所有分行
调用方式	实时接口
调用流程	--
应用场景	--

2 请求地址
Url： https://{baseUrl}/api/tp6004
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
页数	pageNo	int	O	默认1
页显示数	pageSize	int	O	默认 10
分行查询请求	request	QueryBranchBankRequest	M	不能为空

QueryBranchBankRequest 的字段

名称	Json标签	类型	属性	取值说明
总行Id	bankId	Int	M	不能为空
城市编码	cityCode	String(64)	M	不能为空

请求示例:
{
  "pageNo": 1,
  "pageSize": 2,
  "request": {
    "bankId": 1,
    "cityCode": "1101"
  }
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页码	pageNo	Int	M	--
页显示数	pageSize	Int	M	--
总数	totalRecord	In	M	--
分支行信息集合	results	List	M	--

QueryBranchBankResp 字段：

名称	Json标签	类型	属性	取值说明
联行号	bankLinkNo	String(64)	M	--
银行名称	bankName	String(32)	M	--
银行名称英文	bankNameEn	String(32)	M	--
省份编码	bankProvinceCode	String(32)	M	--
省份名称	bankProvinceName	String(32)	M	--
省份名称英文	bankProvinceNameEn	String(32)	M	--
城市编码	bankCityCode	String(32)	M	--
城市名称	bankCityName	String(32)	M	--
城市名称英文	bankCityNameEn	String(32)	M	--

返回示例:
{
  "pageNo": 1,
  "pageSize": 2,
  "results": [
    {
      "bankCityCode": "1101",
      "bankCityName": "北京市",
      "bankCityNameEn": "City area",
      "bankLinkNo": "102100005001",
      "bankName": "中国工商银行股份有限公司牡丹卡中心",
      "bankNameEn": "Industrial and Commercial Bank of China Peony Card Center",
      "bankProvinceCode": "11",
      "bankProvinceName": "北京市",
      "bankProvinceNameEn": "Beijing"
    },
    {
      "bankCityCode": "1101",
      "bankCityName": "北京市",
      "bankCityNameEn": "City area",
      "bankLinkNo": "102100010022",
      "bankName": "中国工商银行股份有限公司票据营业部北京分部",
      "bankNameEn": "Industrial and Commercial Bank of China Beijing Branch",
      "bankProvinceCode": "11",
      "bankProvinceName": "北京市",
      "bankProvinceNameEn": "Beijing"
    }
  ],
  "totalPage": 33,
  "totalRecord": 324
}

5.5.8 人民币付款交易确认

1 功能描述

交易代码	TP1019
功能名称	人民币付款交易确认
功能描述	确认人民币付款交易，正式提交。
调用方式	实时接口
调用流程	调用5.5.1 人民币付款接口提交交易后，调用此接口确认交易。
应用场景	发起人民币付款，向境内收款人发起付款后，确认人民币付款交易，正式提交。

2 请求地址
Url： https://{baseUrl}/api/tp1019
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	Long	M	报价ID

请求示例:
{
  "quoteId": 1143128725976500000
}

4 响应字段

名称	Json标签	类型	属性	取值说明
交易流水号	bizFlowNo	String	M	对应人民币付款交易的唯一流水号
商户订单号	merOrderNo	String	M	商户订单号
报价ID	quoteId	long	M	报价ID
扣款币种	debitCurrency	string	M	扣款币种，3位标准货币代码
扣款金额	debitAmount	Decimal	M	扣款金额
到账金额	amount	Decimal	M	到账金额
汇率	rate	String	M	汇率
状态	status	String	M	订单状态 "0":"接受", "1":"成功", "2":"失败", "3":"处理中"
手续费币种	feeCurrency	String	O	所收取的手续费币种
手续费币种	feeAmount	Decimal	O	所收取的手续费金额
实际付款金额	actualPayAmount	Decimal	O	实际付款金额

返回示例:
{
  "amount": 794,
  "bizFlowNo": "31603082110252600000",
  "debitAmount": 100,
  "debitCurrency": "EUR",
  "expireTime": 1692584735000,
  "merOrderNo": "LNQ202308230001",
  "quoteId": 1143128725976500000,
  "rate": 7.9402,
  "status": "3"
}

5.5.9 新增结汇收款人

1 功能描述

交易代码	TP1021
功能名称	新增结汇收款人
功能描述	新增结汇收款人，为结汇付款做准备。
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp1021
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
主体类型	subjectType	String(2)	M	主体类型：00-个人，01-企业
收款方姓名	payeeName	String(64)	M	收款方姓名
证件号	certNo	String(32)	M	证件号
手机号	mobile	String(11)	M	手机号
国家/地区	country	String(2)	M	国家/地区
币种	currency	String(3)	M	币种
银行联行号	bankCode	String(32)	C	银行联行号对公必传
银行账号	bankAcctNo	String(32)	M	银行账号
支行名称	branchName	String(128)	M	支行名称
业务类型	businessType	String(32)	M	业务类型 00-货贸（包含电商） 01-服贸多条以,隔开
收款人分类	payeeType	String(4)	M	收款人分类参数详见字段说明
补充材料	supplementaryMaterialsPath	String	C	补充材料地址参数详见字段说明(收款人类型为：供应商、广告商、物流商、代理商、其他服务商、服务商、员工、企业供应商的法人/董事/股东需上传)
营业执照	businessLicensePath	String	C	营业执照地址业务类型为货贸如果收款方是个人，且非公司本身的重要控制人，务必提供个人收款方代表的供应商公司主体的营业执照，如果收款方是公司，可暂不提供
身份证正面	frontCardPath	String	O	身份证正面地址业务类型为货贸且主体类型为个人选传
身份证反面	backCardPath	String	O	身份证反面地址业务类型为货贸且主体类型为个人选传
法人身份证正面	legalFrontCardPath	String	O	法人身份证正面地址业务类型为货贸且主体类型为企业选传
法人身份证反面	legalBackCardPath	String	O	法人身份证反面地址业务类型为货贸且主体类型为企业选传
法人身份证号	legalCertNo	String	C	法人身份证号业务类型为货贸且主体类型为企业必传

请求示例:
{
  "country": "CN",
  "bankAcctNo": "6213326400000000000",
  "payeeType": "2001",
  "mobile": "13850000000",
  "branchName": "中国银行",
  "subjectType": "00",
  "certNo": "350321195601010006",
  "payeeName": "Sponge baby",
  "currency": "CNY",
  "businessType": "00"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
code码	code	String(16)	M	code返回码，SUCC--成功，FAIL--失败
收款人信息唯一编号	bizFlow	String(32)	M	收款人信息唯一编号
收款人状态	status	String(2)	M	收款人状态 00-审核中 01-成功 02-失败 03-待补充材料

返回示例:
{
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "code": "SUCC",
    "message": null,
    "bizFlow": "ctWYP7ZybGB8nu7ClPEBOY21iKldamdzCxFk",
    "status": "03"
  },
  "succ": true
}

5.5.10 修改结汇收款人

1 功能描述

交易代码	TP1022
功能名称	修改结汇收款人
功能描述	修改结汇收款人，为结汇付款做准备。
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp1022
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
收款人信息唯一编号	bizFlow	String(64)	M	收款人信息唯一编号，由查询接口获取
主体类型	subjectType	String(2)	M	主体类型：00-个人，01-企业
收款方姓名	payeeName	String(64)	M	收款方姓名
证件号	certNo	String(32)	M	证件号
手机号	mobile	String(11)	M	手机号
国家/地区	country	String(2)	M	国家/地区
币种	currency	String(3)	M	币种
银行联行号	bankCode	String(32)	C	银行联行号对公必传
银行账号	bankAcctNo	String(32)	M	银行账号
支行名称	branchName	String(128)	M	支行名称
业务类型	businessType	String(32)	M	业务类型 00-货贸（包含电商） 01-服贸多条以,隔开
收款人分类	payeeType	String(4)	M	收款人分类参数详见字段说明
补充材料	supplementaryMaterialsPath	String	C	补充材料地址参数详见字段说明(收款人类型为：供应商、广告商、物流商、代理商、其他服务商、服务商、员工、企业供应商的法人/董事/股东需上传)
营业执照	businessLicensePath	String	C	营业执照地址业务类型为货贸如果收款方是个人，且非公司本身的重要控制人，务必提供个人收款方代表的供应商公司主体的营业执照，如果收款方是公司，可暂不提供
身份证正面	frontCardPath	String	O	身份证正面地址业务类型为货贸且主体类型为个人选传
身份证反面	backCardPath	String	O	身份证反面地址业务类型为货贸且主体类型为个人选传
法人身份证正面	legalFrontCardPath	String	O	法人身份证正面地址业务类型为货贸且主体类型为企业选传
法人身份证反面	legalBackCardPath	String	O	法人身份证反面地址业务类型为货贸且主体类型为企业选传
法人身份证号	legalCertNo	String	C	法人身份证号业务类型为货贸且主体类型为企业必传

请求示例:
{
  "bizFlow": "ctWYP7ZybGB8nu7ClPEBOY21iKldamdzCxFk",
  "country": "CN",
  "bankAcctNo": "6213326400000000000",
  "payeeType": "2001",
  "mobile": "13850000000",
  "branchName": "中国银行",
  "subjectType": "00",
  "certNo": "350321195601010006",
  "payeeName": "Sponge baby",
  "currency": "CNY",
  "supplementaryMaterialsPath": "uploadFile/hzfr.jpg",
  "businessType": "00"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
code码	code	String(16)	M	code返回码，SUCC--成功，FAIL--失败

返回示例:
{
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "code": "SUCC",
    "message": null,
    "bizFlow": null,
    "status": null
  },
  "succ": true
}

5.5.11 删除结汇收款人

1 功能描述

交易代码	TP1023
功能名称	删除结汇收款人
功能描述	删除结汇收款人，为结汇付款做准备。
调用方式	实时接口
调用流程	---
应用场景	---
2 请求地址
Url： https://{baseUrl}/api/tp1023
Method： POST
3 请求字段
名称	Json标签
---	---
收款人信息唯一编号	bizFlow

请求示例:
{
  "bizFlow": "ctWYP7ZybGB8nu7ClPEBOY21iKldamdzCxFk"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
code码	code	String(16)	M	code返回码，SUCC--成功，FAIL--失败

返回示例:
    {
  "code": "S00000",
  "msg": "请求成功",
  "data": {
    "code": "SUCC"
  },
  "succ": true
}

5.5.12 查询结汇收款人

1 功能描述

交易代码	TP3017
功能名称	查询结汇收款人
功能描述	查询结汇收款人
调用方式	实时接口
调用流程	---
应用场景	---

2 请求地址
Url： https://{baseUrl}/api/tp3017
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
收款方姓名	payeeName	String(64)	O	收款方姓名，不支持模糊查询
手机号	mobile	String(11)	O	手机号，不支持模糊查询
银行账号	bankAcctNo	String(32)	O	银行账号，不支持模糊查询
页数	pageNo	Int	O	分页页数，默认1
页显示数	pageSize	Int	O	分页页显示数，默认10，最大100

请求示例:
{
  "bankAcctNo": "6213326400000319910"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页码	pageNum	Int	M	当前页码
页显示数	pageSize	Int	M	页显示数
总数	total	Int	M	总数
收款人信息集合	list	List	M	收款人信息集合

PayeeRes 的字段

名称	Json标签	类型	属性	取值说明
收款人信息唯一编号	bizFlow	String(64)	M	收款人信息唯一编号，由查询接口获取
主体类型	subjectType	String(2)	M	主体类型：00-个人，01-企业
收款方姓名	payeeName	String(64)	M	收款方姓名，脱敏
证件号	certNo	String(32)	M	证件号，脱敏
手机号	mobile	String(11)	M	手机号，脱敏
国家/地区	country	String(2)	M	国家/地区
币种	currency	String(3)	M	币种
银行账号	bankAcctNo	String(32)	M	银行账号
支行名称	branchName	String(128)	M	支行名称
业务类型	businessType	String(32)	O	业务类型 00-货贸（包含电商） 01-服贸多条以,隔开
收款人分类	payeeType	String(4)	O	收款人分类参数详见字段说明
状态	status	String(2)	O	状态 00-审核中 01-成功 02-失败 03-待补充材料

返回示例:
{
  "pageNum": 1,
  "pageSize": 10,
  "total": 1,
  "pages": 1,
  "list": [
    {
      "payeeName": "Sponge baby",
      "bankAcctNo": "6213***0000",
      "businessType": "00",
      "payeeType": "2001",
      "country": "CN",
      "branchName": "中国银行",
      "subjectType": "00",
      "currency": "CNY",
      "certNo": "350321*********006",
      "mobile": "138****0000",
      "status": "01",
      "bizFlow": "ctWYP7ZybGB8nu7ClPEBOY21iKldamdzCxFk"
    }
  ]
}

5.6 国际汇款

5.6.1 查询国际付款字段

1 功能描述

交易代码	TP3005
功能名称	查询国际付款字段
功能描述	查询向不同国家付款所需的字段
调用方式	实时接口
调用流程	--
应用场景	国际付款前查询向不同国家付款所需的字段
2 请求地址
Url： https://{baseUrl}/api/tp3005
Method： POST
3 请求字段
名称	Json标签
---	---
收款国家	countryCode
收款币种	arriveCurrency
扣款币种	debitCurrency
付款方式	payType
收款账户类型	accountType

请求示例:
{
  "accountType": "1",
  "arriveCurrency": "HKD",
  "countryCode": "HK",
  "debitCurrency": "USD",
  "payType": "local"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
付款方	payer	ParamField	M	付款方所需字段要求
收款方	payee	ParamField	M	收款方所需字段要求
枚举值字段	selectOption	Object	O	收付款方某些字段的枚举值，code为对应值描述，value为对应的应传值
选填条件	condition	Object	O	前置选填条件
支持银行列表	bankList	List	O	支持的收款银行名称列表如果不为空则该地区币种收款银行只能从列表中筛选

ParamField 的字段

名称	Json标签	类型	属性	取值说明
必填字段	required	List	M	必填字段
选填字段	optional	List	M	选填字段

返回示例:
{
  "bankList": [
    "Tai Yau Bank Limited",
    "THE CHUGOKU BANK, LTD.",
    "NatWest Markets Plc Hong Kong Branch",
    "JPMorgan Chase Bank, N.A.",
    "SOCIETE GENERALE HONGKONG BRANCH",
    "EAST WEST BANK",
    "China Guangfa Bank Co., Ltd.",
    "NATIXIS HONG KONG BRANCH",
    "Yintran Group Holdings Limited",
    "BANK OF TAIWAN",
    "Taiwan Shin Kong Commercial Bank Co., LTD.",
    "044-OCBC Wing Hang Bank Limited",
    "Shinhan Bank Hong Kong Branch",
    "Banco Bilbao Vizcaya Argentaria S.A., Hong Kong Branch",
    "Far Eastern International Bank Co Ltd.",
    "Credit Agricole Corporate and Investment Bank",
    "KBC Bank N.V. Hong Kong Branch",
    "YUANTA COMMERCIAL BANK CO.,LTD",
    "Fubon Bank (Hong Kong) Limited",
    "Dah Sing Bank, Limited",
    "Mega International Commercial Bank Co Ltd",
    "052-DBS Bank (Hong Kong) Ltd.",
    "Hong Leong Bank Berhad Hong Kong Branch",
    "E.Sun Commercial Bank, Ltd.",
    "064-Bank of China (Hong Kong) Limited",
    "O-Bank Co., Ltd",
    "BANK OF INDIA",
    "Deutsche Bank AG Hong Kong Branch",
    "Shanghai Commercial Bank Limited",
    "Woori Bank Hong Kong Branch",
    "Bank SinoPac (Hong Kong Branch)",
    "China Minsheng Banking Corp., Ltd.",
    "Mashreq Bank Public Shareholding Company",
    "STANDARD CHARTERED BANK (HONG KONG) LIMITED",
    "The Shizuoka Bank, Ltd.",
    "The Bank of New York Mellon, Hong Kong Branch",
    "DZ BANK AG DEUTSCHE ZENTRALGENOSSENSCHAFTSBANK, FRANKFURT AM MAIN, HONG KONG BRANCH",
    "HDFC BANK LIMITED",
    "Skandinaviska Enskilda Banken AB",
    "CA Indosuez (Switzerland) SA",
    "ABN AMRO BANK N.V.",
    "BDO UNIBANK, INC.",
    "First Abu Dhabi Bank PJSC",
    "Bank of Dongguan Co., Ltd.",
    "Qatar National Bank (Q.P.S.C.)",
    "Octopus Cards Limited",
    "Morgan Stanley Bank Asia Limited",
    "CHANG HWA COMMERCIAL BANK LIMITED",
    "ZA Bank Limited",
    "Taiwan Business Bank, Ltd.",
    "Bank of Communications (Hong Kong) Ltd.",
    "PHILIPPINE NATIONAL BANK",
    "UBS AG Hong Kong",
    "Kookmin Bank",
    "035-OCBC Wing Hang Bank Limited",
    "Sumitomo Mitsui Banking Corporation",
    "Cathay United Bank Company, Limited, Hong Kong Branch",
    "Taishin International Bank Co Ltd",
    "014-Bank of China (Hong Kong) Limited",
    "032-DBS Bank (Hong Kong) Ltd.",
    "STATE BANK OF INDIA",
    "019-Bank of China (Hong Kong) Limited",
    "Shanghai Pudong Development Bank Co., Ltd.",
    "Bank of America N.A.",
    "UNICREDIT BANK AG HONG KONG BRANCH",
    "Credit Industriel et Commercial, Hong Kong Branch",
    "Barclays Bank PLC",
    "LGT Bank AG., HK Branch",
    "INDUSTRIAL AND COMMERCIAL BANK OF CHINA LIMITED",
    "026-Bank of China (Hong Kong) Limited",
    "Toronto Dominion Bank",
    "CHINA BOHAI BANK CO., LTD.",
    "Welab Bank Limited",
    "The Bank of Nova Scotia",
    "Mizuho Bank, Ltd.",
    "030-Bank of China (Hong Kong) Limited",
    "Melli Bank Plc",
    "PUNJAB NATIONAL BANK",
    "China Development Bank Hong Kong Branch",
    "Agricultural Bank of China Limited, Hong Kong Branch",
    "MITSUBISHI UFJ TRUST AND BANKING CORPORATION",
    "OVERSEA - CHINESE BANKING CORPORATION LIMITED",
    "Malayan Banking Berhad Hong Kong Branch",
    "Taipei Fubon Commercial Bank",
    "029-INDUSTRIAL AND COMMERCIAL BANK OF CHINA (ASIA) LIMITED",
    "Mox Bank Limited",
    "Erste Group Bank AG",
    "UniCard Solution Limited",
    "ING Bank N.V., Hong Kong",
    "FIRST COMMERCIAL BANK LTD HONG KONG BRANCH",
    "Commerzbank AG, Hong Kong Branch",
    "WeChat Pay Hong Kong Limited",
    "BNP PARIBAS SECURITIES SERVICES",
    "Fusion Bank Limited",
    "Ping An Bank Co., Ltd.",
    "Credit Suisse AG Hong Kong Branch",
    "Commonwealth Bank of Australia",
    "TNG (Asia) Limited",
    "Australia and New Zealand Banking Corporation Limited",
    "State Street Bank & Trust Company, Hong Kong",
    "072-INDUSTRIAL AND COMMERCIAL BANK OF CHINA (ASIA) LIMITED",
    "BANK OF MONTREAL",
    "The Shanghai Commercial & Savings Bank Ltd.Hong Kong Branch.",
    "BANK J. SAFRA SARASIN LTD, HONG KONG BRANCH",
    "Hua Xia Bank Co., Limited",
    "COOPERATIEVE RABOBANK U.A.",
    "012-Bank of China (Hong Kong) Limited",
    "Banque Pictet & Cie SA",
    "Hang Seng Bank Ltd.",
    "Public Bank (Hong Kong) Limited",
    "The Bank of East Asia, Limited",
    "051-CHINA CITIC BANK INTERNATIONAL LIMITED",
    "China Merchants Bank Co. Ltd. Hong Kong Branch",
    "UNION BANK OF INDIA",
    "Sumitomo Mitsui Trust Bank, Limited, Hong Kong Branch",
    "HKT Payment Limited",
    "016-DBS Bank (Hong Kong) Ltd.",
    "Union Bancaire Privee, UBP SA",
    "CANADIAN IMPERIAL BANK OF COMMERCE",
    "ICICI BANK LIMITED",
    "United Overseas Bank Limited",
    "Chong Hing Bank Limited",
    "DBS Bank Ltd, HK Branch",
    "033-Bank of China (Hong Kong) Limited",
    "Bank of Singapore Limited",
    "China Construction Bank (Asia) Corporation Limited",
    "THE SHIGA BANK, LTD.",
    "CTBC BANK CO., LTD",
    "CHINA ZHESHANG BANK CO., LTD.",
    "INDUSTRIAL BANK OF KOREA",
    "The Chiba Bank Ltd",
    "EPAYLINKS TECHNOLOGY CO., LIMITED",
    "CMB Wing Lung Bank Limited",
    "EFG Bank AG Hong Kong Branch",
    "PT. BANK NEGARA INDONESIA (PERSERO) TBK.",
    "China Everbright Bank",
    "Intesa Sanpaolo S.p.A., Hong Kong",
    "KEB HANA BANK",
    "Nanyang Commercial Bank, Limited",
    "Airstar Bank Limited",
    "Taiwan Cooperative Bank",
    "Ant Bank (Hong Kong) Limited",
    "INDIAN OVERSEAS BANK",
    "China Construction Bank Corporation, Hong Kong Branch",
    "Alipay Financial Services (HK) Limited",
    "HUA NAN COMMERCIAL BANK LTD. (HK BRANCH)",
    "Bank of Communications Co., Ltd. Hong Kong Branch",
    "PayMe",
    "BANGKOK BANK PUBLIC COMPANY LIMITED",
    "BANK JULIUS BAER AND CO LTD HONG KONG",
    "BANCO SANTANDER S.A.",
    "070-Bank of China (Hong Kong) Limited",
    "The Hachijuni Bank Ltd",
    "UCO BANK HONG KONG",
    "Chiyu Banking Corporation Limited",
    "CIMB BANK BERHAD",
    "Wells Fargo Bank, N.A. Hong Kong Branch",
    "Autotoll Limited",
    "BNP PARIBAS HONG KONG BRANCH",
    "TAI SANG BANK LTD.",
    "Citibank (Hong Kong) Limited",
    "Royal Bank of Canada, Hong Kong Branch",
    "CATHAY BANK",
    "018-CHINA CITIC BANK INTERNATIONAL LIMITED",
    "LAND BANK OF TAIWAN CO.,LTD.",
    "National Bank of Pakistan",
    "33 Financial Services Limited",
    "Citibank N.A. Hong Kong",
    "The Hongkong and Shanghai Banking Corporation Limited",
    "Industrial Bank Co., Ltd., Hong Kong Branch",
    "National Australia Bank Limited",
    "036-Bank of China (Hong Kong) Limited",
    "Ping An OneConnect Bank (Hong Kong) Limited",
    "NongHyup Bank",
    "Westpac Banking Corporation",
    "031-Bank of China (Hong Kong) Limited",
    "Livi Bank Limited",
    "MUFG Bank, Ltd."
  ],
  "condition": {
    "bankAcctType": {
      "01": [
        "payeeCompanyName"
      ]
    }
  },
  "payee": {
    "optional": [
      "payeeCompanyName",
      "payeeAddress"
    ],
    "required": [
      "payeeBankAccountNo",
      "bankAcctType",
      "payeeResidentCountry",
      "payeeBankSwift",
      "payeeBankName"
    ]
  },
  "payer": {
    "optional": [
      "payerType"
    ],
    "required": [
      "payerBankName",
      "payerRegisteredCountry",
      "endSenderName"
    ]
  },
  "selectOption": {
    "bankAcctType": [
      {
        "code": "To B",
        "value": "01"
      }
    ],
    "payerType": [
      {
        "code": "B",
        "value": "01"
      }
    ]
  }
}

5.6.2 国际汇款接口

1 功能描述

交易代码	TP1004
功能名称	国际汇款接口
功能描述	发起国际汇款，向境外收款人发起汇款。
调用方式	实时接口
调用流程	调用5.6.1 查询国际付款字段获取收款方所需字段后，依据相应字段，向收款人发起汇款。
应用场景	发起国际汇款，向境外收款人发起汇款

2 请求地址
Url： https://{baseUrl}/api/tp1004
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string	M	商户自定义订单号，需唯一
收款国家	countryCode	string	M	iso 3166-1标准2字代码
收款币种	arriveCurrency	string	M	收款方币种，3位标准货币代码
扣款币种	debitCurrency	string	M	扣款币种，3位标准货币代码
付款方式	payType	string	M	可选值：local 或者 swift
收款账户类型	accountType	string	M	收款账户类型:1-银行账户，06-钱包
扣款金额	debitAmount	string	C	扣款金额，即扣款币种对应金额
收款金额	arriveAmount	string	C	收款金额（扣款金额和收款金额2选1填写，若同时填写，以收款金额为准）
汇款目的	purpose	string	M	详见6.1.4汇款目的列表
付款方字段	payer	object	M	按照相应国家tp3005返回的数据进行填写
收款方字段	payee	Object	M	按照相应国家tp3005返回的数据进行填写
关联fx流水号	fxBizFlow	String	O	关联fx流水号，若填写此字段，则本接口不校验余额，
				但扣款金额不能大于对应fx订单的金额
汇款附言	tradeComments	String	O	汇款附言
汇款目的备注	purposeRemark	String	O	当purpose为99时，汇款目的以此为准
是否为pobo同名付款	poboFlag	String	O	是否为pobo同名付款 0,1 为1时表示此笔交易为pobo同名付款，为0时表示非pobo同名付款，不填默认为0 ，仅限于开通POBO功能的SWIFT使用，其余不可传

请求示例:
{
  "accountType": "1",
  "arriveAmount": "150",
  "arriveCurrency": "HKD",
  "countryCode": "HK",
  "debitCurrency": "USD",
  "merOrderNo": "LNQ1692868278983",
  "payType": "local",
  "payee": {
    "bankAcctType": "01",
    "payeeBankAccountNo": "0018564",
    "payeeBankName": "CIMB BANK BERHAD",
    "payeeBankSwift": "10086000",
    "payeeCompanyName": "company",
    "payeeResidentCountry": "HK"
  },
  "payer": {
    "endSenderName": "company",
    "payerBankName": "DBS",
    "payerRegisteredCountry": "US"
  },
  "purpose": "99",
  "purposeRemark": "下发一笔"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
扣款币种	debitCurrency	String	M	扣款币种
收款币种	arriveCurrency	String	M	收款币种
汇率	rate	String	M	汇率
扣款金额	debitAmount	String	M	扣款金额
收款金额	arriveAmount	String	M	收款金额
报价ID	quoteId	long	M	报价ID
报价有效期	expireTime	long	M	unix时间戳，此次询价的有效时间。
商户订单号	merOrderNo	String	M	商户传入的订单号
关联fx流水号	fxBizFlow	String	O	关联fx流水号

请求示例:
{
  "arriveAmount": "150",
  "arriveCurrency": "HKD",
  "debitAmount": "19.33",
  "debitCurrency": "USD",
  "expireTime": 1694164280000,
  "merOrderNo": "LNQ1692868278983",
  "quoteId": 1144318423257358336,
  "rate": "7.7599586136"
}

5.6.3 国际汇款交易确认

1 功能描述

交易代码	TP1005
功能名称	国际汇款交易确认
功能描述	确认国际汇款交易，正式提交。
调用方式	实时接口
调用流程	调用5.6.2 国际汇款接口提交交易后，调用此接口确认交易。
应用场景	发起国际汇款，向境外收款人发起汇款后，确认国际汇款交易，正式提交。

2 请求地址
Url： https://{baseUrl}/api/tp1005
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	Long	M	报价ID
回调url	callbackUrl	String	M	回调通知Url

请求示例:
{
  "callbackUrl": "https://www.baidu.com",
  "quoteId": "1144318423257358336"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	long	M	报价ID
收款国家	countryCode	string	M	iso 3166-1标准2字代码
收款币种	arriveCurrency	string	M	收款方币种，3位标准货币代码
扣款币种	debitCurrency	string	M	扣款币种，3位标准货币代码
付款方式	payType	string	M	可选值：local 或者 swift
收款账户类型	accountType	string	M	暂只支持输入 1（银行账户）
付款金额	arriveAmount	string	M	收款金额
扣款金额	debitAmount	String	M	扣款金额
汇率	rate	String	M	汇率
状态	status	String	M	订单状态
结果码	code	String	M	交易结果码
结果描述	message	String	M	交易结果描述
交易流水号	bizFlow	String	M	对应国际汇款交易的唯一流水号
商户订单号	merOrderNo	String	M	商户订单号
关联fx流水号	fxBizFlow	String	O	关联fx流水号

响应示例:
{
  "accountType": "1",
  "arriveAmount": "150.00",
  "arriveCurrency": "HKD",
  "bizFlow": "41483082417125200025",
  "countryCode": "HK",
  "debitAmount": "19.33",
  "debitCurrency": "USD",
  "merOrderNo": "LNQ1692868370983",
  "payType": "local",
  "quoteId": 1144318423257358300,
  "rate": "7.7599586136",
  "status": "PROCESS"
}

5.6.4 国际汇款历史交易查询
1 功能描述

交易代码	TP3006
功能名称	国际汇款历史交易查询
功能描述	国际汇款历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的国际汇款历史交易

2 请求地址
Url： https://{baseUrl}/api/tp3006
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long	O	Unxi13位时间戳，查询结束时间，闭区间
报价ID	quoteId	Long	O	报价ID
商户订单号	merOrderNo	String	O	商户订单号

请求示例:
{
  "quoteId":"1144318423257358336"
}

检查

若startTime与endTime没填，则quoteId和merOrderNo中必填其一。若quoteId和merOrderNo都没填，则startTime与endTime为必填，且间隔不能超过24小时

4 响应字段
返回对象是List
RemittanceHistory 的字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	long	M	报价ID
收款国家	countryCode	string	M	iso 3166-1标准2字代码
收款币种	arriveCurrency	string	M	收款方币种，3位标准货币代码
扣款币种	debitCurrency	string	M	扣款币种，3位标准货币代码
付款方式	payType	string	M	可选值：local 或者 swift
收款账户类型	accountType	string	M	暂只支持输入 1（银行账户）
付款金额	arriveAmount	string	M	收款金额
扣款金额	debitAmount	String	M	扣款金额
汇率	rate	String	M	汇率
状态	status	string	M	状态码
结果码	resCode	String	M	交易结果码
结果描述	resMessage	String	M	交易结果描述
交易流水号	bizFlow	String	M	对应国际汇款交易的唯一流水号
商户订单号	merOrderNo	String	M	商户订单号
付款和收款字段	xxxxxx	String	M	相应国家字段不同，根据tp3005返回的数据
关联fx流水号	fxBizFlow	String	O	关联fx流水号
手续费金额	feeAmt	Decimal	O	所收取的手续费金额
手续费币种	feeCurrency	String	O	所收取的手续费币种

请求示例:
{
  "list": [
    {
      "accountType": "1",
      "arriveAmount": 150,
      "arriveCurrency": "HKD",
      "bankAcctType": "01",
      "bizFlow": "41483082417125200025",
      "callbackUrl": "https://api",
      "clientLanguage": "CN",
      "countryCode": "HK",
      "createTime": 1692868372512,
      "debitAmount": 19.33,
      "debitCurrency": "USD",
      "endSenderName": "company",
      "expireTime": 1694164372000,
      "feeAmt": 2.5,
      "feeCurrency": "USD",
      "lockDirection": "BUY",
      "merOrderNo": "LNQ1692868370983",
      "merchantNo": "004401100035",
      "payType": "local",
      "payeeBankAccountNo": "0018564",
      "payeeBankName": "CIMB BANK BERHAD",
      "payeeBankSwift": "10086000",
      "payeeCompanyName": "company",
      "payeeResidentCountry": "HK",
      "payerBankName": "DBS",
      "payerRegisteredCountry": "US",
      "payerType": "01",
      "purpose": "下发一笔",
      "quoteId": 1144318423257358300,
      "rate": 7.7599586136,
      "riId": 12765794,
      "status": "SUCC",
      "updateTime": 1692868402111
    }
  ]
}

5.6.5 国际汇款交易结果通知

1 功能描述

交易代码	TP2003
功能名称	国际汇款交易结果通知
功能描述	国际汇款的交易结果异步通知
调用方式	通知接口
调用流程	--
应用场景	5.6.3 国际汇款交易确认发起成功且交易处理完毕后，
将根据5.1.5 国际汇款交易确认参数内的回调Url进行回调通知最终结果。

检查

2 请求地址
Url： 5.6.3 国际汇款交易确认中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
报价ID	quoteId	long	M	报价ID
收款国家	countryCode	string	M	iso 3166-1标准2字代码
收款币种	arriveCurrency	string	M	收款方币种，3位标准货币代码
扣款币种	debitCurrency	string	M	扣款币种，3位标准货币代码
付款方式	payType	string	M	可选值：local 或者 swift
收款账户类型	accountType	string	M	暂只支持输入 1（银行账户）
付款金额	arriveAmount	string	M	收款金额
扣款金额	debitAmount	String	M	扣款金额
汇率	rate	String	M	汇率
付款状态	status	string	M	订单状态
结果码	code	String	M	交易结果码
结果描述	message	String	M	交易结果描述
交易流水号	bizFlow	String	M	对应国际汇款交易的唯一流水号
商户订单号	merOrderNo	String	M	商户订单号
关联fx流水号	fxBizFlow	String	O	关联fx流水号
手续费金额	feeAmt	Decimal	O	所收取的手续费金额
手续费币种	feeCurrency	String	O	所收取的手续费币种

请求示例:
{
  "accountType": "1",
  "arriveAmount": "150.00",
  "arriveCurrency": "HKD",
  "bizFlow": "41483082417125200025",
  "countryCode": "HK",
  "debitAmount": "19.33",
  "debitCurrency": "USD",
  "feeAmt": 2.5,
  "feeCurrency": "USD",
  "merOrderNo": "LNQ1692868370983",
  "payType": "local",
  "quoteId": 1144318423257358300,
  "rate": "7.7599586136",
  "status": "SUCC"
}

5.6.6 异常退款状态通知
1 功能描述

交易代码	TP2014
功能名称	异常退款状态通知
功能描述	异常退款状态结果异步通知
调用方式	通知接口
调用流程	--
应用场景	渠道异步通知终态变更后的退款状态通知(须先调用5.12.1 回调地址设置配置通知地址)

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址
Url：【待补充】callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户号	merchantNo	String(32)	M	商户号
商户订单号	merOrderNo	String(32)	M	商户订单号
业务流水号	batchNo	String(32)	M	国际汇款申请返回的流水号
单笔订单号	applyNo	String(32)	M	单笔订单号
交易类型	receiveType	String(3)	M	交易类型 00:结汇付款 01:国际汇款
收款金额	arriveAmount	decimal(18,2)	M	收款金额
收款币种	arriveCurrency	String(3)	M	收款币种
扣款金额	debitAmount	decimal(18,2)	M	扣款金额
扣款币种	debitCurrency	String(3)	M	扣款币种
手续费金额	feeAmount	decimal(18,2)	O	手续费金额
手续费币种	feeCurrency	String(3)	O	手续费币种
付款状态	status	String(8)	M	订单状态
交易结果码	resCode	String(16)	M	交易结果码
交易结果描述	message	String(255)	O	交易结果描述
退款金额	refundAmount	decimal(18,2)	O	退款金额(暂无)
退款币种	refundCurrency	String(3)	O	退款币种(暂无)
退款手续费金额	refundFeeAmount	decimal(18,2)	O	退款手续费金额(暂无)
退款手续费币种	refundFeeCurrency	String(3)	O	退款手续费币种(暂无)
退款批次号	refundBatchNo	String(32)	M	退款批次号
退款单笔订单号	refundApplyNo	String(32)	M	退款单笔订单号
备注	remark	String(255)	O	备注

请求示例:
{
  "applyNo": "42413032213515200508",
  "arriveAmount": 2.33,
  "arriveCurrency": "USD",
  "batchNo": "41273032213465300482",
  "debitAmount": 2.33,
  "debitCurrency": "USD",
  "feeAmount": 1.02,
  "feeCurrency": "USD",
  "merOrderNo": "528bef8587554dd2b5da9cfb38f70f54",
  "merchantNo": "004401100035",
  "receiveType": "01",
  "refundApplyNo": "42413032213515200508",
  "refundBatchNo": "41273032213465300482",
  "resCode": "OE0005",
  "resMessage": "拒绝-禁止的付款人",
  "status": "FAIL"
}

5.7 内部转账

5.7.1 商户内部间转账

1 功能描述
| 交易代码 | TP1010 |
| 功能名称 | 商户内部间转账 |
| 功能描述 | 同为在BZcircle注册的商户，向对方BZcircle账户进行转账 |
| 调用方式 | 实时接口 |
| 调用流程 | -- |
| 应用场景 | 同为在BZcircle注册的商户，向对方BZcircle账户进行转账 |
2 请求地址
Url： https://{baseUrl}/api/tp1010
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string(32)	M	商户自定义的唯一订单号
收款方账号	toAcctNo	string(32)	M	收款方账号
收款方账户名	toAcctName	string(255)	M	收款方账户名
转账币种	currency	string(3)	M	转账币种
转账金额	amount	Decimal(18,2)	M	转账金额
汇款目的	purpose	string(3)	M	汇款目的，参见附录6.1.4付款目的
附言	remark	string(255)	O	附言

请求示例:
{
  "amount": "200",
  "currency": "CNY",
  "merOrderNo": "LNQ1692927910914",
  "purpose": "1",
  "toAcctName": "LNQ169111697028608",
  "toAcctNo": "004896102184"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
业务流水号	bizFlow	string(32)	M	BZcircle侧唯一业务订单号
结果状态	status	string(6)	M	结果状态 SUCC：成功 FAIL：失败
手续费币种	feeCurrency	string(3)	O	手续费币种，若手续费模式为实时收取时，则返回此字段
手续费金额	feeAmount	string(22)	O	手续费金额，若手续费模式为实时收取时，则返回此字段

返回示例:
{
  "bizFlow": "70483082509451100044",
  "feeAmount": "1.28",
  "feeCurrency": "USD",
  "status": "SUCC"
}

5.8 充值

5.8.1 充值交易历史查询

1 功能描述

交易代码	TP3008
功能名称	充值历史交易查询
功能描述	充值历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的充值历史交易
2 请求地址
Url： https://{baseUrl}/api/tp3008
Method： POST
3 请求字段
名称	Json标签
---	---
查询起始时间	beginDate
查询结束时间	endDate
业务订单号	batchNo
充值银行	bankCode
充值币种	currency
查询最小金额	minAmount
查询最大金额	maxAmount
充值状态	status
第几页	pageNum
每页多少条	pageSize

请求示例:
{
  "batchNo":"11473082516153900018"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页码	pageNum	Int	M	--
页显示数	pageSize	Int	M	--
总数	total	Int	M	--
充值流水信息集合	list	List	M	--

RechargeRecord 的字段

名称	Json标签	类型	属性	取值说明
充值订单	batchNo	string(32)	M	充值订单
充值币种	curType	string(3)	M	充值币种，3位标准货币代码
充值金额	amount	decimal(18,2)	M	充值金额
实际入账金额	actualAmt	decimal(18,2)	M	实际入账金额
充值银行	bank	string(64)	M	充值银行
充值账户	account	string(64)	M	充值账户
充值状态	status	string(2)	M	充值状态 01: "待处理"; 02: "充值成功"; 03: "充值拒绝"
入账时间	updateTime	Date	M	入账时间
手续费金额	feeAmt	decimal(18,2)	O	手续费金额
手续费币种	feeCurType	string(3)	O	手续费币种
充值账号	acctNo	string(32)	O	充值账号
付款方名称	payerName	string(255)	O	付款方名称

返回示例:
{
  "list": [
    {
      "account": "终极测试",
      "acctNo": "100058384000",
      "actualAmt": 810.8,
      "amount": 820,
      "bank": "星展银行(客户资金)",
      "batchNo": "11473082516153900018",
      "createTime": 1692951339000,
      "curType": "USD",
      "feeAmt": 9.2,
      "feeCurType": "USD",
      "merchantName": "终极测试",
      "merchantNo": "004401100035",
      "payerName": "终极测试",
      "remark": "",
      "status": "02",
      "updateTime": "2023-08-25 16:15:40"
    }
  ],
  "pageNum": 1,
  "pageSize": 10,
  "pages": 1,
  "total": 1
}

##5.8.2 充值成功通知
1 功能描述

交易代码	TP2011
功能名称	充值成功通知
功能描述	充值成功通知
调用方式	通知接口
调用流程	--
应用场景	在商户的充值请求审核成功后，BZcircle会向商户发送充值成功通知

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址
Url：【待补充】callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
充值订单号	batchNo	string(32)	M	充值订单号
商户号	merchantNo	string(24)	M	商户号
商户名称	merchantName	string(128)	M	商户名称
充值币种	curType	string(3)	M	充值币种，3位标准货币代码
充值金额	amount	decimal(18,2)	M	充值金额
实际入账金额	actualAmt	decimal(18,2)	M	实际入账金额
入账时间	rechargeTime	Long	M	入账时间
备注	remark	string(255)	O	备注
充值银行	bank	string(32)	O	充值银行
手续费金额	feeAmt	decimal(18,2)	O	手续费金额
手续费币种	feeCurType	string(3)	O	手续费币种
充值账号	acctNo	string(32)	O	充值账号
充值账户	account	string(255)	O	充值账户
付款方名称	payerName	string(255)	O	付款方名称

请求示例:
{
  "account": "终极测试",
  "acctNo": "100058384000",
  "actualAmt": 810.8,
  "amount": 820,
  "bank": "星展银行(客户资金)",
  "batchNo": "11473082516153900018",
  "curType": "USD",
  "feeAmt": 9.2,
  "feeCurType": "USD",
  "merchantName": "终极测试",
  "merchantNo": "004401100035",
  "payerName": "终极测试",
  "rechargeTime": 1692951339,
  "remark": ""
}

5.9 提现

##5.9.1 提现接口
1 功能描述

交易代码	TP1008
功能名称	提现交易申请
功能描述	用于发起境外提现，需提现账户名与商户注册名称相同
调用方式	实时接口
调用流程	--
应用场景	用于发起境外提现，需提现账户名与商户注册名称相同

检查

默认提现账户名称即为商户入网时提供的注册名称

2 请求地址
Url： https://{baseUrl}/api/tp1008
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string(32)	M	商户传入本次交易唯一订单号
币种	currency	string(3)	M	提现币种，3位标准货币代码
金额	amount	decimal(18,2)	M	提现金额
银行账号/IBAN	bankAccountNo	string(64)	M	提现银行账号或IBAN
银行名称	bankName	string(64)	M	提现银行名称
银行地址	bankAddress	string(256)	M	提现银行的地址
swift code	swiftCode	string(32)	M	提现银行的swift code
代理行名称	proxyBankName	string(64)	O	代理行名称
代理行地址	proxyBankAddress	string(256)	O	代理行地址
代理行swift code	proxySwiftCode	string(32)	O	代理行swift code
汇款附言	remark	string(64)	O	汇款附言
回调url	callbackUrl	string(256)	M	回调通知Url

请求示例:
{
  "amount": "200",
  "bankAccountNo": "6248348300000000",
  "bankAddress": "New York",
  "bankName": "Citibank",
  "callbackUrl": "https://www.baidu.com",
  "currency": "USD",
  "merOrderNo": "LNQ1692952039986",
  "remark": "取笔钱",
  "swiftCode": "7643843"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string(32)	M	商户传入本次交易唯一订单号
业务流水号	bizFlow	string(32)	M	BZcircle生成的唯一流水号
状态	status	string(8)	M	交易结果状态
结果码	code	string(8)	M	交易结果代码
结果描述	message	string(64)	M	交易结果描述

返回示例:
{
  "bizFlow": "51823082516272000024",
  "code": "S00001",
  "merOrderNo": "LNQ1692952039986",
  "message": "S00001",
  "status": "ACCEPT"
}

5.9.2 提现交易历史查询

1 功能描述

交易代码	TP3007
功能名称	提现历史交易查询
功能描述	提现历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的提现历史交易

2 请求地址
Url： https://{baseUrl}/api/tp3007
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	startTime	Long	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endTime	Long	O	Unxi13位时间戳，查询结束时间，闭区间
业务订单号	bizFlow	String(32)	O	BZcircle生成的唯一流水号
商户订单号	merOrderNo	String(32)	O	商户订单号

请求示例:
{
  "bizFlow":"51823082516272000024"
}

检查

若startTime与endTime没填，则bizFlow和merOrderNo中必填其一。若bizFlow和merOrderNo都没填，则startTime与endTime为必填，且间隔不能超过24小时

4 响应字段
返回对象是List
WithdrawBean 的字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string(32)	M	商户传入本次交易唯一订单号
币种	currency	string(3)	M	提现币种，3位标准货币代码
金额	amount	decimal(18,2)	M	提现金额
提现账户名称	bankAccountName	string(64)	M	提现账户名称
银行账号/IBAN	bankAccountNo	string(64)	M	提现银行账号或IBAN
银行名称	bankName	string(64)	M	提现银行名称
银行地址	bankAddress	string(256)	M	提现银行的地址
swift code	swiftCode	string(32)	M	提现银行的swift code
代理行名称	proxyBankName	string(64)	O	代理行名称
代理行地址	proxyBankAddress	string(256)	O	代理行地址
代理行swift code	proxySwiftCode	string(32)	O	代理行swift code
汇款附言	remark	string(64)	O	汇款附言
回调地址	callbackUrl	string(256)	M	回调地址
业务流水号	bizFlow	string(32)	M	BZcircle生成的唯一流水号
交易结果状态	status	string(8)	M	交易结果状态
交易结果码	code	string(8)	M	交易结果码
结果描述	message	string(64)	M	交易结果描述
提现发起时间	createTime	long	M	提现发起时间

返回示例:
{
  "list": [
    {
      "amount": 200,
      "bankAccountName": "Final Test",
      "bankAccountNo": "6248348300000000",
      "bankAddress": "New York",
      "bankName": "Citibank",
      "bizFlow": "51823082516272000024",
      "code": "S00000",
      "currency": "USD",
      "merOrderNo": "LNQ1692952039986",
      "message": "Processing",
      "remark": "Success",
      "status": "SUCC",
      "swiftCode": "7643843"
    }
  ]
}

##5.9.3 提现结果通知
1 功能描述

交易代码	TP2005
功能名称	提现结果通知
功能描述	提现结果异步通知
调用方式	通知接口
调用流程	--
应用场景	提现交易发起成功且交易处理完毕后，将根据提现交易参数内的回调Url进行回调通知最终结果。

检查

本通知将按照间隔时间渐长的方式持续通知24小时.
商户应当以http 200返回，若通知持续时间结束仍未正常返回，则不再通知。

2 请求地址
Url：提现交易中的 callbackUrl
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
商户订单号	merOrderNo	string(32)	M	商户传入本次交易唯一订单号
币种	currency	string(3)	M	提现币种，3位标准货币代码
金额	amount	decimal(18,2)	M	提现金额
提现账户名称	bankAccountName	string(64)	M	提现账户名称
银行账号/IBAN	bankAccountNo	string(64)	M	提现银行账号或IBAN
银行名称	bankName	string(64)	M	提现银行名称
银行地址	bankAddress	string(256)	M	提现银行的地址
swift code	swiftCode	string(32)	M	提现银行的swift code
代理行名称	proxyBankName	string(64)	O	代理行名称
代理行地址	proxyBankAddress	string(256)	O	代理行地址
代理行swift code	proxySwiftCode	string(32)	O	代理行swift code
汇款附言	remark	string(64)	O	汇款附言
业务流水号	bizFlow	string(32)	M	BZcircle生成的唯一流水号
交易结果状态	status	string(8)	M	交易结果状态
交易结果码	code	string(8)	M	交易结果码
结果描述	message	string(64)	M	交易结果描述

请求示例:
{
  "amount": 200,
  "bankAccountName": "Final Test",
  "bankAccountNo": "6248348300000000",
  "bankAddress": "New York",
  "bankName": "Citibank",
  "bizFlow": "51823082516272000024",
  "code": "S00000",
  "currency": "USD",
  "merOrderNo": "LNQ1692952039986",
  "message": "Processing",
  "remark": "Success",
  "status": "SUCC",
  "swiftCode": "7643843"
}

5.10 手续费

##5.10.1 手续费交易历史查询
1 功能描述

交易代码	TP3010
功能名称	手续费历史交易查询
功能描述	手续费历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的手续费历史交易

2 请求地址
Url： https://{baseUrl}/api/tp3010
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明

请求示例:
def)

4 响应字段

名称	Json标签	类型	属性	取值说明
查询起始时间	beginDate	Long	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endDate	Long	O	Unix13位时间戳，查询开始时间，闭区间
业务订单号	batchNo	String(32)	O	BZcircle生成的唯一流水号
业务类型	busiType	String(6)	O	业务类型
手续费状态	status	String(3)	O	手续费状态 10: "未收取", 11: "已收取", 12: "已退回"
第几页	pageNum	Integer	O	查询第几页
每页多少条	pageSize	Integer	O	每页多少条，每页最多支持100条

请求示例:
{
  "beginDate": "1654012800000",
  "endDate": "1656691199999",
  "pageNum": 1,
  "pageSize": 2
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页码	pageNum	Int	M	--
页显示数	pageSize	Int	M	--
总数	total	Int	M	--
手续费信息集合	list	List	M	--

FeeFlowRes 的字段

名称	Json标签	类型	属性	取值说明
订单号	batchNo	string(32)	M	订单号
商户订单号	merSingleBatchNo	string(32)	O	商户传入本次交易唯一订单号
业务类型	bizType	String(6)	M	业务类型
手续费币种	feeCurrency	String(3)	O	手续费币种，3位标准货币代码
手续费币种对应交易金额	feeTradeAmt	decimal(18,2)	M	手续费币种对应交易金额
手续费状态	status	string(2)	M	手续费状态 10: "未收取", 11: "已收取", 12: "已退回"
交易币种	tradeCurrency	string(3)	M	交易币种，3位标准货币代码
交易金额	tradeAmt	decimal(18,2)	M	交易金额
交易时间	tradeTime	Date	M	交易时间
备注	remark	string(1024)	M	备注

返回示例:
{
  "list": [
    {
      "batchNo": "62782070121531600019",
      "bizType": "000020",
      "feeCurrency": "HKD",
      "feeTradeAmt": 1,
      "feeType": "10",
      "remark": "收款手续费流水",
      "status": "11",
      "tradeAmt": 21,
      "tradeCurrency": "GBP",
      "tradeTime": "2022-07-01 21:53:18"
    },
    {
      "batchNo": "62782070121461400016",
      "bizType": "000020",
      "feeCurrency": "HKD",
      "feeTradeAmt": 1,
      "feeType": "10",
      "remark": "收款手续费流水",
      "status": "11",
      "tradeAmt": 21,
      "tradeCurrency": "GBP",
      "tradeTime": "2022-07-01 21:46:15"
    }
  ],
  "pageNum": 1,
  "pageSize": 2,
  "pages": 131,
  "total": 261
}

5.11 账务

##5.11.1 账户余额查询
1 功能描述

交易代码	TP3004
功能名称	账户余额查询
功能描述	当前账户余额查询
调用方式	实时接口
调用流程	--
应用场景	当前账户余额查询

2 请求地址
Url： https://{baseUrl}/api/tp3004
Method： POST

3 请求字段

名称	Json标签	类型	属性	取值说明
币种	currency	String(3)	O	币种，若不传则为查询所有币种账户

请求示例:
{

}

4 响应字段
接口返回对象为: List
CurrencyBalance 字段：

名称	Json标签	类型	属性	取值说明
币种	currency	String(3)	M	币种
余额	balance	String(3)	M	账户余额
账户状态	status	String(3)	M	账户状态: on 为启用， off为禁用

返回示例:
[
  "list": [
    {
      "balance": "108130286.44",
      "currency": "USD",
      "status": "on"
    },
    {
      "balance": "146204.15",
      "currency": "EUR",
      "status": "on"
    },
    {
      "balance": "10193838.00",
      "currency": "JPY",
      "status": "on"
    },
    {
      "balance": "9504470.68",
      "currency": "HKD",
      "status": "on"
    },
    {
      "balance": "8892161.38",
      "currency": "CNY",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "IDR",
      "status": "on"
    },
    {
      "balance": "17920.68",
      "currency": "GBP",
      "status": "on"
    },
    {
      "balance": "8494.97",
      "currency": "DKK",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "SGD",
      "status": "on"
    },
    {
      "balance": "120.00",
      "currency": "AUD",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "CHF",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "KRW",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "NGN",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "NOK",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "NZD",
      "status": "on"
    },
    {
      "balance": "0.00",
      "currency": "SEK",
      "status": "on"
    }
  ]
]

5.11.2 账务流水交易查询

1 功能描述

交易代码	TP3009
功能名称	账务流水历史交易查询
功能描述	账务流水历史交易查询
调用方式	实时接口
调用流程	--
应用场景	查询以往的账务流水历史交易

2 请求地址
Url： https://{baseUrl}/api/tp3009
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
查询起始时间	beginDate	Long	O	Unix13位时间戳，查询开始时间，闭区间
查询结束时间	endDate	Long	O	Unix13位时间戳，查询开始时间，闭区间
业务订单号	batchNo	String(32)	O	Easyloon生成的唯一流水号
币种	currency	String(3)	O	币种
收支类型	flowType	String(3)	O	收支类型 1: "入金", 2: "出金"
流水类型	busiType	String(3)	O	6.1.6流水类型
第几页	pageNum	Integer	O	查询第几页
每页多少条	pageSize	Integer	O	每页多少条，每页最多支持100条

请求示例:
{
  "beginDate": "1654012800000",
  "endDate": "1656691199999",
  "pageNum": 1,
  "pageSize": 2
}

4 响应字段

名称	Json标签	类型	属性	取值说明
当前页码	pageNum	Int	M	--
页显示数	pageSize	Int	M	--
总数	total	Int	M	--
账务流水信息集合	list	List	M	--

CurFlowRes 的字段

名称	Json标签	类型	属性	取值说明
账务流水订单	batchNo	string(32)	M	账务流水订单
币种	currency	string(3)	M	账务流水币种，3位标准货币代码
流水类型	busiType	String(3)	M	6.1.6流水类型
入金	inAmount	decimal(18,2)	M	入金金额
出金	outAmount	decimal(18,2)	M	出金金额
可用金额	vailAmount	decimal(18,2)	M	可用金额
交易时间	busiDate	Date	M	交易时间

返回示例:
{
  "list": [
    {
      "applyNo": "62782070121531600019",
      "batchNo": "62782070121531600019",
      "busiDate": "2022-07-01 21:53:18",
      "busiType": "C11",
      "currency": "HKD",
      "id": 0,
      "outAmount": 1,
      "totalAmount": 60514.33,
      "vailAmount": 50333.6
    },
    {
      "applyNo": "62782070121531600019",
      "batchNo": "62782070121531600019",
      "busiDate": "2022-07-01 21:53:18",
      "busiType": "C13",
      "currency": "GBP",
      "id": 0,
      "inAmount": 21,
      "totalAmount": 29078.31,
      "vailAmount": 10352.31
    }
  ],
  "pageNum": 1,
  "pageSize": 2,
  "pages": 310,
  "total": 620
}

5.12 配置

5.12.1 回调地址设置

1 功能描述

交易代码	TP1014
功能名称	对于通知接口，设置回调地址
功能描述	对于通知接口，设置回调地址
调用方式	实时接口
调用流程	--
应用场景	对于无交易传参的callback接口，单独设置回调地址

2 请求地址
Url： https://{baseUrl}/api/tp1014
Method： POST
3 请求字段

名称	Json标签	类型	属性	取值说明
回调地址	callbackUrl	string(64)	M	回调地址
接口类型	tradeCode	string(6)	M	回调的接口类型

请求示例:
{
  "tradeCode": "TP2007",
  "callbackUrl": "https://www.baidu.com"
}

4 响应字段

名称	Json标签	类型	属性	取值说明
结果码	code	string(6)	M	SUCC代表成功

返回示例:
{
  "code": "SUCC"
}

5 业务接口

5.1 商户入网

5.1.1 代理商商户入网和VA开户整合

5.1.2 商户入网结果通知

5.2 授权

5.2.1 申请授权

5.2.2 申请token

5.3 收款

5.3.1 VA开户申请

5.3.2 VA开户查询

5.3.3 贸易收款到账通知

5.3.4 收款VA入账查询接口

5.3.5 贸易订单申请

5.3.6 贸易订单申请结果通知

5.3.7 贸易订单申请信息查询

5.3.8 收款流水和贸易订单关联

5.3.9 收款流水和贸易订单关联结果通知

5.3.10 收款流水和贸易订单关联查询

5.3.11 电商订单申请

5.3.12 电商额度查询

5.3.13 VA开户结果通知

5.3.14 新增账户持有人

5.3.15 修改账户持有人

5.3.16 账户持有人补充信息

5.3.17 账户持有人查询

5.3.18 账户持有人审核结果通知

5.4 换汇

5.4.1 牌价查询

5.4.2 FX交易

5.4.3 换汇历史交易查询

5.4.4 FX交易结果通知

5.4.5 查询支持换汇币种对

5.4.6 委托换汇提交申请

5.4.7 委托换汇申请取消

5.5 人民币付款

5.5.1 人民币付款

5.5.2 人民币付款业务查询

5.5.3 系统通知商户付款结果

5.5.4 查询总行

5.5.5 查询总行下分行支持省份

5.5.6 查询总行下分行支持城市

5.5.7 查询总行下某城市所有分行

5.5.8 人民币付款交易确认

5.5.9 新增结汇收款人

5.5.10 修改结汇收款人

5.5.11 删除结汇收款人

5.5.12 查询结汇收款人

5.6 国际汇款

5.6.1 查询国际付款字段

5.6.2 国际汇款接口

5.6.3 国际汇款交易确认

5.6.5 国际汇款交易结果通知

5.7 内部转账

5.7.1 商户内部间转账

5.8 充值

5.8.1 充值交易历史查询

5.9 提现

5.9.2 提现交易历史查询

5.10 手续费

5.11 账务

5.11.2 账务流水交易查询

5.12 配置

5.12.1 回调地址设置