updateAmount
该接口支持商户在使用 pay (单笔支付) 完成预授权之后、请款之前,向上调整授权金额。本接口仅可在以下条件均满足时调用:
- 已完成一笔预授权;
- 首笔预授权响应成功;
- 首笔预授权返回的 incrementalAuthorizationAvailable 的值为
true; - 尚未发起请款;
- 授权未关闭;
- 当前不存在在途的增量授权请求。
注意:系统默认最多支持 10 次调额。若超过 10 次,或在请款后调用本接口,Antom 返回
INCREMENTAL_NOT_SUPPORT。
入参
updateRequestId String REQUIRED
商家分配的唯一 ID,用于识别 updateAmount 接口改价请求。
注意:此参数为 API 幂等性参数。Antom 使用此参数进行幂等性控制。
更多信息:
- 最大长度:64 字符
amount Amount REQUIRED
本次调价后的新授权总额(非增量)。多次调额场景下,amount 必须严格大于当前已授权总额,即上一次成功调额后的金额;若尚未调额,则为首笔预授权的 paymentAmount。
注意:
- 该参数仅支持调增,不支持调减。
- 币种必须与首笔预授权保持一致。
出参
result Result REQUIRED
接口调用的结果。
updateRequestId String REQUIRED
调额请求 ID。
更多信息:
- 最大长度:64 字符
paymentId String REQUIRED
Antom 生成的原始支付 ID。
更多信息:
- 最大长度:64 字符
amount Amount REQUIRED
改价后的金额。
请求
响应
结果处理逻辑
- 当 result.resultStatus 的值为
S时:本次调整额度请求受理成功,并不代表实际调额成功。具体结果通过 notifyPayment 返回,其中 notifyType 的值为UPDATE_AMOUNT_RESULT。 - 当 result.resultStatus 的值为
F时:本次调整额度请求受理失败,本次增量的金额不生效,后续请款请求仍按照 预授权的金额或上次增量成功的金额为准。 - 当 result.resultStatus 的值为
U时:本次调整额度请求未知,请通过 inquiryPayment 接口查询本次调整额度的结果,或等待 notifyPayment 的通知。
结果码
注意:系统仅返回英文版结果码信息(resultMessage),表格中的中文文案仅供理解和参考,实际返回值以英文为准。
resultCode | resultStatus | resultMessage | 操作建议 |
|
| 成功。 | 无需进一步操作。 |
|
| 当前这笔交易不支持 incremental。触发条件:1. 当首笔 authorization 的 incrementalAuthorizationAvailable=false 时;2. 当 authorization 已经发生 capture 时(包含在途 capture),或者已经关单时;3. 当 authorization 已经存在在途 incremental 时。(The current transaction does not support incremental authorization. Triggering conditions include: 1. incrementalAuthorizationAvailable of the initial authorization is false; 2. The authorization has already been captured, including an in-progress capture, or has already been closed; 3. There is already an in-progress incremental authorization for the authorization.) | 请确认首笔授权的 incrementalAuthorizationAvailable 的值为 |
|
| 相同 updateRequestId 但不同金额。(The same updateRequestId is used with a different amount.) | 使用不同的 updateRequestId 重新发起请求,或核对金额后使用相同的 updateRequestId 重新发起。 |