inquiryPayout需要签名验签
调用本接口查询外部转账结果。
- 您需要设定timeout机制中断查询,以处理转账后无明确结果的情况;
- 若调用createPayout接口后2小时没有接收到万里汇通知,且调用inquiryPayout接口后transferResult.resultCode返回
UNKNOWN
,联系万里汇技术支持。
报文结构
万里汇接口报文结构包括:请求头,请求体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| 关于这些参数的解释说明,详见:请求头 |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-CustomerId | 否(有条件) |
| 当平台客户操作商户账户时需要传递 |
入参
transferId String CONDITIONAL
万里汇提现申请成功时返回的代发单据号。
transferId、transferRequestId不能同时为空。
transferRequestId String CONDITIONAL
由集成商定义的唯一转账识别ID。
transferId、transferRequestId不能同时为空。
更多信息:
- 此为幂等字段。
- 最大长度:64 字符
出参
result Result REQUIRED
代表API调用结果。
transferResult Result REQUIRED
代表转账结果。
该字段只有当 result.resultStatus =
S
时才会按需返回。
transferRequestId String REQUIRED
由集成商定义的唯一转账识别ID。
该字段只有当 result.resultStatus =
S
时才会按需返回。
更多信息:
- 此为幂等字段。
- 最大长度:64 字符
transferId String REQUIRED
由万里汇定义的转账识别ID。
该字段只有当 result.resultStatus =
S
时才会按需返回。
更多信息:
- 最大长度:64 字符
transferFinishTime DateTime
本次转账请求的完成时间。
该字段只有当 result.resultStatus =
S
时才会按需返回。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
transferFromDetail TransferFromDetail REQUIRED
支付方提供的转账详细信息。
该字段只有当 result.resultStatus =
S
时才会按需返回。
transferToDetail TransferToDetail REQUIRED
收款方接受的转账详细信息。
该字段只有当 result.resultStatus =
S
时才会按需返回。
请求
响应
响应处理
集成商调用接口之后,万里汇会返回给集成商以下两个字段:
- result.resultStatus:API调用结果
- transferResult.resultStatus:转账结果
集成商调用接口后,万里汇响应集成商API调用结果。
result.resultStatus 字段取值范围为:
result.resultStatus | 描述 |
S | API请求成功。 |
F | API请求失败。 失败原因参见结果码(即 result.resultCode 和 result.resultMessage) |
U | API响应结果为 重试策略:
如果问题依旧,请联系万里汇技术支持。 |
transferResult.resultStatus 取值范围为:
result.resultCode
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | 重试,若问题依旧,联系万里汇技术支持 |
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. | 需要人工介入,联系万里汇技术支持以解决此问题 |
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请求方法为 |
transferResult.resultCode
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
PROCESSING | S | The transfer is in process. | 万里汇正在处理该请求,可稍后再次调用inquiryPayout接口查询结果 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题 |
ORDER_IS_CLOSED | F | The order is closed. | 换单重试 |
ORDER_NOT_FOUND | U | Order not found. | 使用正确的订单信息重试 |
ORDER_NOT_EXIST | F | The order does not exist. | 订单不存在,重新下单 |
ORDER_IS_REVERSED | F | The order is reversed. | 换单重试 |
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
USER_ACCOUNT_ABNORMAL | F | The user account status is abnormal. | 使用其他用户信息重试。如问题依旧,咨询万里汇技术支持 |
USER_STATUS_ABNORMAL | F | The status of the user is abnormal. Retry with another card. | 更换用户信息重试 |
AMOUNT_EXCEED_LIMIT | F | The amount exceeds the limit. | 确认金额正确后重试 |
RISK_REJECT | F | The transfer is rejected for risk control reasons. | 通知用户需要通过风控审核 |
CARD_INFO_NOT_MATCH | F | The card information does not match. | 换卡重试 |
BALANCE_NOT_ENOUGH | F | Balance is not enough. | 确认余额充足后重试 |
CURRENCY_NOT_SUPPORT | F | The currency is not supported. | 确认币种信息正确后重试 |
UN_SUPPORT_BUSINESS | F | Unsupported business. | 使用正确的参数重试 |
USER_NO_PERMISSION | F | User does not have permission. | 检查用户权限是否正确并重试 |