交易调单
请求头参数:
| 请求头名称 | 必填 | 类 型 | 描述 |
|---|---|---|---|
txnId | M | string | 当前交易订单号 |
Authorization | M | string | 通过调单发起回调或邮件通知获取 |
Accept-Language | O | string | 当前支持(zh-CN,zh-TW,en-US) |
获取当前调单详情
获取当前调单详情
端点目标 URL
响应data参数
| 字段名 | 类型 | 说明 |
|---|---|---|
amountStr | String | 交易金额(收款时为到账金额,付款时为付款金额) |
payAmountStr | String | 扣款金额(仅付款时返回) |
payeeAccountNo | String | 收款方账号 |
payeeName | String | 收款方名称 |
payerAccountNo | String | 付款方账号 |
payerName | String | 付款方名称 |
transactionDirection | String | 交易方向(in:收款,out:付款) |
status | status | 当前调单状态 |
dynamicTemplateData | Object | 调单问题(仅状态为待提供时返回) |
remark | String | 订单备注 |
dynamicTemplateData字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
templateId | String | 当前模板id |
templateVersionId | String | 版本id |
businessId | String | 业务id |
fieldList | list<fieldObj> | 收款方名称 |
fieldObj字段结构
| 字段名 | 类型 | 说明 |
|---|---|---|
field | String | 字段标识 |
label | String | 字段名 |
fieldType | String | 字段类型 |
required | String | 是否必填(1:必填,0:非必填) |
sorted | String | 排序 |
config | config | 字段配置(fieldType值返回对应的类型) |
children | list<fieldObj> | 子字段 |
config字段可能的类型
| fieldType | 类型 |
|---|---|
TEXT | textConfig |
LONG | textConfig |
DECIMAL | textConfig |
MUL_TEXT | textConfig |
AMOUNT | amountConfig |
DATE | dateConfig |
DATE_RANGE | dateConfig |
SELECT | selectConfig |
MULTI_SELECT | selectConfig |
CHECKBOX | selectConfig |
FILE | fileConfig |
IMAGE | fileConfig |
CASCADER | cascaderConfig |
LIST | listConfig |
CONTAINER | containerConfig |
textConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
regex | String | 字段正则校验表达式 |
regexTips | String | 字段正则校验错误提示 |
placeholder | String | 字段填写提示语 |
amountConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
amount.placeholder | String | 字段填写提示语 |
currency.dictKey | String | 可选币种字典key |
dateConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
min | String | 可以选择的最小时间(yyyy-MM-dd HH:mm:ss) |
max | String | 可以选择的最大时间(yyyy-MM-dd HH:mm:ss) |
selectConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
dictKey | String | 可选项字典key |
fileConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
placeholder | String | 字段填写提示语 |
maxCount | String | 最大文件数量 |
maxSize | String | 单个文件大小 |
extensions | String | 允许的文件类型(多个用,隔开) |
cascaderConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
dictKey | String | 可选项字典key |
multiple | String | 是否多选(1:是,0:否) |
listConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
rows | String | 默认行数 |
maxRows | String | 最大行数 |
minRows | String | 最小行数 |
content | String | 描述 |
containerConfig对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
content | String | 描述 |
集成
当前调单详情调用输出
{
"code": "0",
"msg": "success",
"serverTime": "1769654914087",
"data": {
"amountStr": "USD 445.45",
"payAmountStr": "USD 500.00",
"payeeAccountNo": "123123123",
"payeeName": "nale",
"payerAccountNo": "1990688358606745600",
"payerName": "future test6",
"transactionDirection": "out",
"status": "PROVIDED",
"dynamicTemplateData": {
"templateId": "163",
"templateVersionId": "428",
"businessId": "2016474270836506626",
"fieldList": [
{
"field": "CONTAINER",
"label": " ",
"fieldType": "CONTAINER",
"required": "0",
"sorted": "1",
"config": {
"content": ""
},
"children": [
{
"field": "remitterPaymentPurpose",
"label": "付款目的",
"fieldType": "TEXT",
"required": "1",
"sorted": "1",
"config": {
"regex": ""
},
"children": null
},
{
"field": "remitterPaymentMaterial",
"label": "付款材料",
"fieldType": "FILE",
"required": "1",
"sorted": "1",
"config": {
"extensions": "jpg,png,jpeg,pdf",
"maxSize": null,
"maxCount": "10"
},
"children": null
},
{
"field": "field2016474270481477632",
"label": "请提供材料文本",
"fieldType": "TEXT",
"required": "1",
"sorted": "9999",
"config": {},
"children": null
}
]
}
]
}
},
"success": true
}获取字典
获取字典
端点目标 URL
字段说明
调用的特定输入参数
| 字段名称 | 必填 | 类 型 | 描述 |
|---|---|---|---|
dictKey | M | string | 字典key |
响应data参数
| 字段名 | 类型 | 说明 |
|---|---|---|
label | String | 字典名 |
value | String | 字典值 |
describe | String | 字典描述 |
childDict | List | 下级字典 |
集成
获取字典调用输出
{
"code": "0",
"msg": "success",
"serverTime": "1769665336362",
"data": {
"value": "web_collec_met",
"dictId": "149",
"label": "网站的收款方式",
"describe": "",
"childDict": [
{
"value": "ACH",
"dictId": "150",
"label": "ACH",
"describe": ""
},
{
"value": "PayPal",
"dictId": "151",
"label": "PayPal",
"describe": ""
},
{
"value": "other",
"dictId": "152",
"label": "其他",
"describe": ""
}
]
},
"success": true
}上传调单文件
上传调单文件
端点目标 URL
字段说明
请求参数
| 字段名 | 类型 | 说明 |
|---|---|---|
file | file | 文件 |
响应data参数
| 字段名 | 类型 | 说明 |
|---|---|---|
fileUrl | String | 文件url |
fileSize | String | 文件大小 |
fileName | String | 文件名称 |
fileType | String | 文件类型 |
集成
上传调单文件调用输出
{
"code": "0",
"msg": "success",
"serverTime": "1769655599265",
"data": {
"fileUrl": "baseInfo/1990688358606745600/SurveyOrder/MP785460769210467/9a6debb390f04a179a27b713b1d4c3e8.png",
"fileSize": "1292298",
"fileName": "印度尼西亚.png",
"fileType": "png"
},
"success": true
}提交调单问卷
提交调单问卷
端点目标 URL
字段说明
请求参数
| 请求头名称 | 必填 | 类 型 | 描述 |
|---|---|---|---|
templateId | M | String | 当前模板id |
templateVersionId | M | String | 版本id |
businessId | M | String | 业务id |
data | M | Map<String,valueObject> | 问卷填写内容(key为前面获取到的field) |
valueObject可能的类型
| fieldType | 类型 |
|---|---|
TEXT | String |
LONG | String |
DECIMAL | String |
MUL_TEXT | String |
AMOUNT | amountValue |
DATE | String |
DATE_RANGE | dateRangeValue |
SELECT | String |
MULTI_SELECT | List<String> |
CHECKBOX | List<String> |
FILE | List<String> |
IMAGE | List<String> |
CASCADER | List<String> |
LIST | List<Map<String,configValue> |
CONTAINER | / |
amountValue对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
amount | String | 金额数值 |
currency | String | 金额币种 |
dateRangeValue对象信息
| 字段名 | 类型 | 说明 |
|---|---|---|
dateS | String | 时间段开始时间(yyyy-MM-dd HH:mm:ss) |
dateE | String | 时间段结束时间(yyyy-MM-dd HH:mm:ss) |
集成
提交调单问卷调用输入
{
"templateId": "163",
"templateVersionId": "428",
"businessId": "2016758855952498690",
"data": {
"remitterPaymentPurpose": "12512",
"remitterPaymentMaterial": [
"business/PAYMENT_RFI/remitterPaymentMaterial/null/印度尼西亚.png"
]
}
}上传调单文件调用输出
{
"code": "0",
"msg": "succeeded",
"serverTime": "1769667983493",
"success": true
}状态字典
调单状态
| 状态 | 描述 |
|---|---|
PROVIDED | 待提供 |
PENDING | 待审核 |
PASSED | 已通过 |
AUTO_APPROVED | 自动通过 |
CHANNEL_RETURN | 渠道拒绝 |
REJECTED | 待提供 |
PROVIDED | 已拒绝 |
CANCEL | 取消 |
webhook
{
"appId": "1929723739684102144",
"merchantId": "1929723739654762496",
"notificationItems": [
{
"eventCode": "SURVEY_ORDER_STATUS",
"remark": "提交渠道还原材料",
"txnMerchantId": 1929723739654762496,
"txnId": "MP785793214193771",
"status": "AUTO_APPROVED",
"eventDate": 1769686139393
}
]
}Updated 2 days ago