consultPayout
调用此接口可查询预期打款结果,以便在发起打款前调用 createPayout 接口。
结构
报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:
注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:
- 如果字段的数据类型为整数属性,且其值为
20,设置为 "20"。 - 如果字段的数据类型为布尔属性,且其值为
true,设置为 "true"。
入参
transferFromDetail Object REQUIRED
发起人提交的转账详细信息。
注意:
- 如果 transferFromAmount 的值大于0,则 transferToAmount 参数的值必须设置为
0。此时,费用将从transferFromAmount 中扣除。 - 最终从 Antom 全球商家账户中扣除的金额将等于 transferFromAmount 的值。收款人最终收到的金额将为transferFromAmount 的值减去扣除的费用。
transferToDetail Object REQUIRED
发起人转账详情。
注意:
- 如果 transferToAmount 的值大于0,则 transferFromAmount 必须设置为
0。在这种情况下,费用将添加到 transferToAmount 中。 - 最终从 Antom 全球商家账户中扣除的金额将是 TransferToAmount 的值加上费用。受益人最终收到的金额将等于 transferToAmount。
businessSceneCode String REQUIRED
打款业务场景类型。有效值包括:
-
THIRD_PARTY_PAYOUT:表示向第三方银行账户打款(可为企业账户或个人账户)。 -
SAME_NAME_PAYOUT:表示向同名账户打款。
注意:若选择 THIRD_PARTY_PAYOUT,请联系销售团队。
transferOrderAddition Object
扣款补充信息(包括发送方和收款方等详情)。
出参
result Object REQUIRED
表明此接口是否调用成功。
transferFromDetail Object
发起人发起的转账信息。
注意:仅当 result.resultStatus 的值为 S 时,才会返回此字段。
transferToDetail Object
收款人转账详情。
注意:仅当 result.resultStatus 的值为 S 时,才会返回此字段。
请求
响应
结果码
| 结果码 | 值 | 结果码信息 | 行动建议 |
|---|---|---|---|
| SUCCESS | S | 成功。 | 接口调用成功,无需进一步操作。 |
| UNKNOWN_EXCEPTION | U | 接口调用失败,原因未知。 | 服务可能不可用,请稍后重试。如果问题仍然存在,请联系 Antom 技术支持。 |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | 请求流量超出限制。 | 再次调用接口以解决问题。如果问题仍然存在,请联系 Antom 技术支持。 |
| PARAM_ILLEGAL | F | 存在非法参数。例如,非数字输入或无效日期。 | 检查并验证请求字段(包括头部字段和正文字段)是否正确且有效。有关每个接口的字段详情,请参阅具体的接口结构部分。 |
| PROCESS_FAIL | F | 发生了一般的业务失败。请勿重试。 | 通常需要人工干预。建议您联系 Antom 技术支持以解决问题。 |
| INVALID_API | F | 调用的接口无效或未激活。 | 检查是否调用了正确的接口。 |
| INVALID_CLIENT | F | 客户端无效。 | 客户端 ID 不存在或无效。 |
| INVALID_SIGNATURE | F | 签名无效。 | 确保请求已使用有效的签名正确签名。 |
| METHOD_NOT_SUPPORTED | F | 服务器不支持请求的 HTTP 方法。 | 确保 HTTP 方法为 POST。 |
| CONTRACT_NOT_EXIST | F | 合同不存在。 | 确保商户已签署合同且输入正确。 |
| FEE_EXCEPTION | U | 接口调用因费用相关问题失败。 | 检查参数并再次调用接口以解决问题。如果问题仍然存在,请联系 Antom 技术支持。 |
| UN_SUPPORT_BUSINESS | F | 不支持的业务。 | 使用了无效参数。请使用正确的信息重试。 |
| USER_NO_PERMISSION | F | 用户没有权限。 | 使用其他用户信息重试。 |
| CURRENCY_NOT_SUPPORT | F | 不支持的货币。 | 确保货币输入正确并重试。 |
| USER_NOT_EXIST | F | 用户不存在。 | 使用正确的用户信息重试。 |
| USER_ACCOUNT_ABNORMAL | F | 用户账户状态异常。 | 使用不同的用户重试。如果问题仍然存在,请联系 Antom 技术支持以获取更多详细信息。 |
| USER_STATUS_ABNORMAL | F | 用户状态异常。 | 用户状态异常。使用另一张卡重试。 |
| CONTRACT_CHECK_FAIL | F | 合同检查失败。 | 确保商户已签署合同且输入正确。 |
| CARD_INFO_NOT_MATCH | F | 卡片信息不匹配。 | 使用正确的卡片信息重试。 |