createMandate

2026-10-20 09:49

POST /v1/payments/createMandate

调用此接口创建一次性支付授权凭证。

结构

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

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

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

入参

mandateRequestId String REQUIRED

商户分配的支付授权凭证请求。系统通过 merchantId + mandateRequestId 查询并唯一识别一次操作。

更多信息：

最大长度：64 字符

accessToken String REQUIRED

授权完成后获得的 Antom 协议 token。该 token 必须属于当前商户，并且能够解析为有效协议。

更多信息：

最大长度：128 字符

paymentAmount Amount REQUIRED

支付金额。

渠道会基于该对象中的确切金额和币种创建一次性支付授权凭证；后续支付必须使用相同的绑定金额和币种。

Show child parameters

出参

result Result REQUIRED

接口调用的结果。

Show child parameters

mandateRequestId String

商户提供的请求 ID。仅当 APO 成功解析该参数时返回。该参数用于请求关联，不表示支付授权凭证成功创建。

更多信息：

最大长度：64 字符

mandateId String

Antom 支付授权凭证 ID。

注意：仅当 result.resultStatus 为 S 时返回，用于后续一次支付调用。

更多信息：

最大长度：64 字符

validFrom Datetime

支付授权凭证生效时间。

注意：仅当 result.resultStatus 为 S 时返回。

更多信息：

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

validUntil Datetime

支付授权凭证过期时间。

注意：仅当 result.resultStatus 为 S 时返回。

更多信息：

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

API Explorer

请求

URL

Method

POST

请求体

响应

响应体

错误码

*resultCode*	状态	结果码信息	行动建议
`SUCCESS`	`S`	新单成功或原 `SUCCESS` 重放	保存原凭证和有效期。
`CURRENCY_NOT_SUPPORT`	`F`	币种不属于系统支持的枚举值	检查并使用系统币种枚举中的值；枚举校验通过不等于渠道支持。已有单据仍按原金额币种比较规则处理。
`INVALID_ACCESS_TOKEN`	`F`	仅新建路径无法解析合法格式的 Token，或渠道权威确认协议不存在且不能细分原因	不返回 Token 内容；修正 Token/重新签约；不得猜测为过期或撤销。
`PAYMENT_NOT_QUALIFIED`	`F`	渠道明确 `NOT_SUPPORT_MERCHANT`	联系接入支持核对渠道能力；不与 API 鉴权混为一谈。
`REPEAT_REQ_INCONSISTENT`	`F`	重复请求内容不一致。	依据原请求记录检查 paymentAmount.currency/value 并恢复原金额币种，不改原单。
`REPEATED_SUBMIT`	`F`	已有同金额币种 `INIT/PROCESSING`；或首次并发插入竞争失败	只允许按本文退避指引等待后同号恢复，或满足 10 分钟条件后换单。
`UNKNOWN_EXCEPTION`	`U`	首笔通道网关结果 `UNKNOWN_EXCEPTION`	原单 `PROCESSING`；保留原请求号，按本文退避指引同号查询；满足 10 分钟条件后可换单。
`REQUEST_TRAFFIC_EXCEED_LIMIT`	`F`	请求流量超过限制；该产品错误码已确认存在	保留原请求号和金额币种；遵循明确的重试指引或按建议退避，不据此推断历史原单终态。
`PARAM_ILLEGAL`	`F`	必填请求参数缺失、空白、超长或格式不合法，或 paymentAmount.value 不是大于 0 的整数等请求校验失败。	按请求字段定义检查并修正参数后重新调用；同号恢复已有单据时保留原业务意图及金额币种，勿原样重复提交非法参数。
`PROCESS_FAIL`	`F`	创建结果装配时单据状态不属于 `SUCCESS`、`FAIL`、`INIT`、`PROCESSING`，或失败结果信息缺失；渠道响应 code 为可识别的标准化 `PROCESS_FAIL` 时，该码亦会返回。	停止后续扣款，保留原请求号、响应和脱敏 trace，联系 Antom 技术支持排查；未核实原创建结果前不以新请求号盲目重建，也不据此改写原单状态。