notifyVostro
当您的万里汇账号成功收到垫付款后,万里汇会调用本接口向您通知来账结果。
报文结构
万里汇接口报文结构包括:请求头,请求体。关于头信息,详见:
请求参数
字段名 | 数据类型 | 是否必填 | 描述 |
fundingId | 字符串 | 是 | 由万里汇定义、用于唯一标识某次垫付请求。 更多信息:
|
balanceResult | Result 对象 | 是 | 代表本次垫付是否成功 |
payerBankAccount | 是 | 付款人银行账户信息 | |
beneficiaryAccount | 是 | 收款人万里汇VA账户信息 | |
balanceChangeAmount | Amount 对象 | 是 | 账户余额变动的金额,即本次充值的金额 |
balanceChangeTime | DateTime 字符串 | 否 | 账户余额变动的时间,即本次充值的时间 更多信息:
|
remitInfo | 字符串 | 否 | 垫付请求附加信息 更多信息:
|
响应参数
字段名 | 数据类型 | 是否必填 | 描述 |
result | Result 对象 | 是 | 代表接口调用结果 |
处理逻辑
万里汇使用balanceResult.resultCode
向您返回垫付结果,具体请见balanceResult.resultCode
章节。在收到万里汇的结果通知后,您需要向万里汇发送响应信息,以确认信息已收到。
如果您不向万里汇发送响应信息,万里汇会重新通过以下规则向您发送请求通知:
- 重试总数:最多7次
- 两次重发请求之间的时间间隔:2分钟,10分钟,10分钟,1小时,2小时,6小时,15小时
注意:在您发送响应信息前,请确保正确加签。参见以下响应头代码范例。详见:生成签名及加验签 章节和API概览-响应报文结构
结果码
balanceResult.resultCode
resultCode | resultStatus | resultMessage | 处理建议 |
SUCCESS | S | Success | 无 |
REFUND | S | Refunding success | 无 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
系统错误码 result.resultCode
resultCode | resultStatus | resultMessage | 处理建议 |
SUCCESS | S | Success | 无 |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面,确认请求头和传参是否正确 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
INVALID_API | F | The called API is invalid or not active. | 检查调用API是否正确 |
INVALID_CLIENT | F | The client is invalid. | Client ID 不存在或无效 |
INVALID_SIGNATURE | F | The signature is invalid. | 确认请求正确加签 |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确认HTTP请求方法为 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 联系万里汇技术支持了解当前合约状态,确保合约有效后重试。 |
范例
请求
请求体范例
{
"fundingId": "*****",
"balanceResult": {
"resultCode": "SUCCESS",
"resultMessage": "success",
"resultStatus": "S"
},
"payerBankAccount": {
"accountNo": "*****",
"bankBIC": "payerBic123",
"bankName": "ping**",
"bankRegion": "payerBCC123",
"holderAddress": "payerAddress123",
"holderName": {
"fullName": "xy****"
}
},
"beneficiaryAccount": {
"accountNo": "*****",
"bankBIC": "CHASHK*****",
"holderName": {
"fullName": "x***y"
}
},
"balanceChangeAmount": {
"currency": "HKD",
"value": "3333"
},
"remitInfo": "*****"
}
响应
响应头范例
{
"headers": {
"Content-Type": "application/json",
"client-id": "*****",
"response-time": "2022-03-07T07:49:27Z",
"signature": "algorithm=RSA256,keyVersion=1,signature=VelVji6jp8*****"
}
}
响应体范例
{
"result": {
"resultStatus": "S",
"resultCode": "SUCCESS",
"resultMessage": "success."
}
}