Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

请款(收银台)

POST /v1/payments/capture

此接口用于从用户账户中扣取已授权支付的资金,然后将指定的支付金额转移到商户账户。根据不同场景,授权支付可以使用下列方式之一进行扣款:

  • 全额扣款:扣取全部支付金额。
  • 部分扣款:扣取部分支付金额。

结构

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


注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:

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

入参

captureRequestId String  REQUIRED

商户为识别请款请求而分配的 ID。

更多信息:

  • 此为幂等字段。对于使用相同的 captureRequestId 并达到最终状态(SF)发起的请款请求,应返回相同的请求结果。
  • 最大长度:64 字符

paymentId String  REQUIRED

Antom 为识别支付而分配的支付 ID。 

更多信息:

  • 最大长度:64 字符

captureAmount Amount  REQUIRED

商户要求以交易币种接收的扣款金额。

Show child parameters

出参

result Result  REQUIRED

接口调用的结果。 

Show child parameters

captureRequestId String  

商户为识别请款请求分配的专属 ID。

注意当请款状态成功时,此参数返回。

更多信息:

  • 最大长度:64 字符

captureId String  

Antom 为识别请款分配的专属 ID。

注意当请款状态成功时,此参数返回。

更多信息:

  • 最大长度:64 字符

paymentId String  

Antom 为识别支付而分配的专属 ID。

注意当请款状态成功时,此参数返回。

更多信息:

  • 最大长度:64 字符

captureAmount Amount  

商户要求以交易币种接收的扣款金额。

注意当请款状态成功时,此参数返回。

Show child parameters

captureTime Datetime  

Antom完成请款的时间。 

注意:当请款状态成功时,此参数返回。

更多信息:

  • 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。

acquirerReferenceNo String  

非 Antom 收单机构为交易分配的 ID。  

更多信息:

  • 最大长度:64 字符
API Explorer
示例代码沙箱运行

请求

URL
请求体

响应

响应体

结果码

结果码结果码信息行动建议
SUCCESSS成功

请款成功,无需进一步操作。  

ACCESS_DENIEDF访问被拒绝。

请联系 Antom 技术支持获取详细原因。  

AUTH_CANCELLEDF支付授权已取消。

使用新的 paymentRequestId 来发起支付。

AUTH_EXPIREDF支付授权已过期。

使用新的 paymentRequestId 来发起支付。

AUTH_NOT_FOUNDF找不到支付授权。

请联系 Antom 技术支持获取详细原因。  

CAPTURE_AMOUNT_EXCEED_AUTH_LIMITF请款总额超过了授权支付金额的限制。

使用不超过授权支付金额的金额创建新的请款请求,或联系 Antom 技术支持。 

CAPTURE_IN_PROCESSU请款处理中。

等待 Antom 的通知或查询请款结果。  

CURRENCY_NOT_SUPPORTF币种不受支持。

检查请求中使用的币种,例如请款币种。如果问题仍然存在请联系 Antom 技术支持获取详细原因。  

MULTI_CAPTURE_NOT_SUPPORTEDF交易不支持多次请款。

请联系 Antom 技术支持获取详细原因。  

INVALID_CONTRACTF合同中的参数值与当前交易不符。

检查合同中的参数值是否与当前交易匹配。如果值匹配,请联系 Antom 技术支持解决问题。  

NO_PAY_OPTIONSF没有可用的支付方式。

请联系 Antom 技术支持以获取详细原因。

ORDER_IS_CANCELEDF交易已取消。

使用新的 paymentRequestId 发起支付。  

ORDER_STATUS_INVALIDF交易状态异常,无法进行支付请款。

检查交易状态。如果值匹配,请联系 Antom 技术支持解决问题。  

PARAM_ILLEGALF缺少必需的参数,或者存在非法参数。例如,非数字输入,无效的日期,或者参数的长度和类型错误。

检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。

PAYMENT_COUNT_EXCEED_LIMITF请款次数超过了支付方式指定的限制。

请联系 Antom 技术支持了解具体限制。

PROCESS_FAILF请款失败。

获取 Antom 技术支持前请勿重试。

REPEAT_REQ_INCONSISTENTF提交的请求已存在,且此请求的参数值与已存在请求不一致。

确保请求中的所有字段相同,或使用新的 paymentRequestId 发起支付。

RISK_REJECTF因风险控制,请求被拒绝。

提示用户,由于风险控制失败,请求被拒绝。

USER_AMOUNT_EXCEED_LIMITF请款金额超过了用户的支付限额。

使用不超过用户支付限额的金额创建新的请款,或联系用户或发卡行。

USER_BALANCE_NOT_ENOUGHF用户的余额不足以完成请款。

请联系 Antom 技术支持获取详细原因。  

USER_NOT_EXISTF在支付方式端,用户的账户不存在。

请联系用户或发卡行。

USER_STATUS_ABNORMALF在支付方式端,用户的账户状态异常。

请联系 Antom 技术支持了解具体原因。

UNKNOWN_EXCEPTIONU由于未知原因,接口调用失败。

再次调用接口解决问题。如果问题持续,请联系 Antom 技术支持。