updateAmount

POST /v1/payments/updateAmount

该接口支持商户在使用 pay (单笔支付) 完成预授权之后、请款之前,向上调整授权金额。本接口仅可在以下条件均满足时调用:

  • 已完成一笔预授权;
  • 首笔预授权响应成功;
  • 首笔预授权返回的 incrementalAuthorizationAvailable 的值为 true
  • 尚未发起请款;
  • 授权未关闭;
  • 当前不存在在途的增量授权请求。

注意系统默认最多支持 10 次调额。若超过 10 次,或在请款后调用本接口,Antom 返回 INCREMENTAL_NOT_SUPPORT

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:

注意:将每个参数(除数组外)的数据类型设置为字符串,即参数的值必须使用英文双引号(" ")包裹起来。例如:

  • 如果参数的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果参数的数据类型为布尔属性,且其值为 true,设置为 "true"。


入参

updateRequestId String  REQUIRED

商家分配的唯一 ID,用于识别 updateAmount 接口改价请求。

注意此参数为 API 幂等性参数。Antom 使用此参数进行幂等性控制。

更多信息:

  • 最大长度:64 字符

paymentId String  REQUIRED

首笔预授权返回的 paymentId。该值应与 pay(单笔支付)返回的 paymentId 的值保持一致。

更多信息:

  • 最大长度:64 字符

amount Amount  REQUIRED

本次调价后的新授权总额(非增量)。多次调额场景下,amount 必须严格大于当前已授权总额,即上一次成功调额后的金额;若尚未调额,则为首笔预授权的 paymentAmount

注意

  • 该参数仅支持调增,不支持调减。
  • 币种必须与首笔预授权保持一致。
Show child parameters

出参

result Result  REQUIRED

接口调用的结果。

Show child parameters

updateRequestId String  REQUIRED

调额请求 ID。

更多信息:

  • 最大长度:64 字符

paymentId String  REQUIRED

Antom 生成的原始支付 ID。

更多信息:

  • 最大长度:64 字符

amount Amount  REQUIRED

改价后的金额。

Show child parameters
API Explorer
示例代码沙箱运行

请求

URL
Method
POST
请求体

响应

响应体

结果处理逻辑

  • result.resultStatus 的值为 S 时:本次调整额度请求受理成功,并不代表实际调额成功。具体结果通过 notifyPayment 返回,其中 notifyType 的值为 UPDATE_AMOUNT_RESULT
  • result.resultStatus 的值为 F 时:本次调整额度请求受理失败,本次增量的金额不生效,后续请款请求仍按照 预授权的金额或上次增量成功的金额为准。
  • result.resultStatus 的值为 U 时:本次调整额度请求未知,请通过 inquiryPayment 接口查询本次调整额度的结果,或等待 notifyPayment 的通知。

结果码

注意:系统仅返回英文版结果码信息resultMessage,表格中的中文文案仅供理解和参考,实际返回值以英文为准。


resultCode

resultStatus

resultMessage

操作建议

SUCCESS

S

成功。

无需进一步操作。

INCREMENTAL_NOT_SUPPORT

F

当前这笔交易不支持 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 的值为 true,且未发生请款或关单,且无在途增量授权请求。

REPEAT_REQ_INCONSISTENT

F

相同 updateRequestId 但不同金额。(The same updateRequestId is used with a different amount.)

使用不同的 updateRequestId 重新发起请求,或核对金额后使用相同的 updateRequestId 重新发起。