支付(代扣)
入参
order Order REQUIRED
包括买家、商家、商品、金额、配送信息和购买环境的订单信息。此字段用于以下目的:
- 在支付过程中,此字段主要用于 Antom 的风险控制或反洗钱。
- 支付完成后,此字段用于记录和报告,如采购追踪和监管报告。
paymentRequestId String REQUIRED
商户为识别支付请求而分配的专属 ID。
更多信息:
- 此为幂等字段。商户使用paymentRequestId字段进行幂等性控制。对于使用相同paymentRequestId值发起的支付请求,如果达到最终状态(
S
或F
),则对请求返回相同的结果。 - 最大长度:64 字符
settlementStrategy SettlementStrategy
支付请求的结算策略。
paymentMethod PaymentMethod REQUIRED
商户或收单机构用来收取支付的支付方式。
creditPayPlan CreditPayPlan
此支付的分期付款计划信息。
注意:如果要支持分期付款,请指定此字段,并请联系 Antom 技术支持获取关于如何提供分期付款的详细信息。
appId String
Antom 为识别小程序应用分配的专属 ID。
注意:当 terminalType 为
MINI_APP
时指定此字段。
更多信息:
- 最大长度:32 字符
paymentExpiryTime Datetime
支付有效期是一个特定时间,超过这个时间后,支付将失效,收单机构或商户必须终止订单处理。默认的支付有效期由合同确定。
注意事项:
- 如果要使用不同于默认时间的支付有效期,请指定此字段。指定的支付有效期必须在支付请求发送后的一分钟内,并且必须遵循正确的格式。
- 通常对于自动扣款,合同中的默认支付有效期是在支付请求发送后的一分钟。例如,如果请求在 2019-11-27T12:00:01+08:30 时发送,支付有效期为 2019-11-27T12:01:01+08:30。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
paymentNotifyUrl URL
用于接收支付结果通知的链接。
注意:如果希望接收自动扣款结果的异步通知,请设置此字段。您也可以在 Antom Dashboard 中设置接收支付结果通知的链接。如果请求和 Antom Dashboard 中都指定了支付通知链接,则请求中指定的值优先。
更多信息:
- 最大长度:2048 字符
productCode String REQUIRED
表示合同中规定的正在使用的支付产品。 对于自动扣款,值设置为 AGREEMENT_PAYMENT
。
出参
result Result REQUIRED
表示接口调用是否成功。如果接口调用成功,代扣支付也成功完成。
paymentRequestId String
商家为识别支付请求而分配的专属 ID。
注意:此字段在接口调用成功时返回。
更多信息:
- 最大长度:64 字符
paymentId String
Antom 为了识别支付而分配的支付 ID。
注意:此字段在接口调用成功时返回。
更多信息:
- 最大长度:64 字符
paymentAmount Amount
商户请求在订单货币中接收的支付金额。
注意:当接口调用成功时,此字段将返回。
paymentTime Datetime
支付达到最终成功状态的日期和时间。
注意:此字段在接口调用成功时返回。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
paymentCreateTime Datetime
支付创建的日期和时间。
注意:此字段在接口调用成功时返回。
更多信息:
- 值遵循 ISO 8601 标准格式。例如,“2019-11-27T12:01:01+08:00”。
pspCustomerInfo PspCustomerInfo
Alipay+ 支付方式的客户信息。
注意:当 Alipay+ 支付方式能够提供相关信息时,此字段返回。
grossSettlementAmount Amount
此字段的值等于交易金额乘以 settlementQuote 的值。当货币兑换预先确定且汇率在交易时锁定时,会返回此字段。
settlementQuote Quote
结算货币与交易货币之间的汇率。当 grossSettlementAmount 返回时,此字段会返回。
请求
响应
更多信息
本节提供有关其他参数的额外信息。详细信息如下:
- order: Antom 不会验证 order 字段中的金额与支付请求中的金额的一致性。订单信息也不应用于资金操作。此字段主要用于风险控制、监管、监管报告和消费记录显示。如果需要 Antom 提供的风险控制能力,请使用 env 字段。
- paymentTime: Antom 成功执行此支付的时间,即支付达到最终成功状态的日期和时间。此值用作后续可取消和可退款时间的开始时间。例如,如果退款期为 6 个月,接受退款的最终截止时间为 paymentTime 加上 6 个月。
结果处理逻辑
对于不同的请求结果,需要执行不同的操作。详细信息如下:
结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | 成功 | 支付成功,无需进一步操作。 |
ACCESS_DENIED | F | 访问被拒绝。 | 详细原因请咨询 Antom 技术支持。 |
CURRENCY_NOT_SUPPORT | F | 货币不受支持。 | 详细原因请咨询 Antom 技术支持。 |
EXPIRED_CODE | F | 支付码已过期。 | 用户需要刷新支付码。 |
INVALID_ACCESS_TOKEN | F | 访问令牌已过期、被撤销或不存在。 | 检查访问令牌是否已过期、被撤销或不存在。重新签署协议并重新初始化授权签名流程。 |
INVALID_CONTRACT | F | 合同中的参数值与当前交易不符。 | 检查合同中的参数值是否与当前交易匹配。如果值匹配,请联系 Antom 技术支持以解决问题。 |
INVALID_MERCHANT_STATUS | F | 由于存在限制,商户状态异常。 | 详细原因请咨询 Antom 技术支持。 |
INVALID_PAYMENT_CODE | F | Antom 无法接受此支付代码。 | 选择其他支付方式。如果支持该支付方式,请联系 Antom 技术支持。 |
INVALID_PAYMENT_METHOD_META_DATA | F | 支付方式元数据无效。 | 检查支付方式的元数据是否正确。如果正确,请联系 Antom 技术支持。 |
KEY_NOT_FOUND | F | 找不到 Antom 或商户的私钥或公钥。 | 检查私钥或公钥是否存在。如果不存在,请在 Antom Dashboard 中上传私钥。 |
MERCHANT_KYB_NOT_QUALIFIED | F | 由于商户的 KYB 状态,支付失败。商户要么未完成 KYB,要么 KYB 状态不适用于此交易。 | 详细原因请咨询 Antom 技术支持。 |
MERCHANT_NOT_REGISTERED | F | 商户未注册。 | 请使用注册接口注册商户。如果无法调用注册接口,请联系 Antom 技术支持。 |
NO_INTERFACE_DEF | F | 接口未定义。 |
检查链接是否正确。请参考接口文档中的端点。 |
NO_PAY_OPTIONS | F | 没有可用的支付选项。 | 如需详细原因,请联系 Antom 技术支持。 |
ORDER_IS_CANCELED | F | 您发起的请求具有与之前已支付但被取消的交易相同的 paymentRequestId。 | 使用新的 paymentRequestId 重新发起支付。 |
ORDER_IS_CLOSED | F | 您发起的请求具有与已关闭交易相同的 paymentRequestId。 | 使用新的 paymentRequestId 重新发起支付。 |
ORDER_NOT_EXIST | F | 订单不存在。 | 检查 paymentId 是否正确。 |
PARAM_ILLEGAL | F | 缺少必需的参数,或者存在非法参数。例如,非数字输入、无效的日期,或者参数的长度和类型错误。 | 检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 |
PAYMENT_AMOUNT_EXCEED_LIMIT | F | 支付金额超过了合同或支付方式允许的最大金额。 | 检查支付金额是否超过限制,或使用较低金额再试一次。请联系 Antom 技术支持了解具体限制。 |
PAYMENT_COUNT_EXCEED_LIMIT | F | 支付次数超过了支付方式规定的限制。 | 请联系 Antom 技术支持了解具体限制。 |
PAYMENT_NOT_QUALIFIED | F | 商户不具备支付资格,可能是因为未注册、未签订自动扣款协议或被禁止支付。 | 详细原因请咨询 Antom 技术支持。 |
PROCESS_FAIL | F | 发生了常见的业务失败。 | 获取 Antom 技术支持前请勿重试。 |
REPEAT_REQ_INCONSISTENT | F | 金额或货币与先前请求不同。 | 确保请求中的所有字段相同,或使用新的 paymentRequestId 重新发起支付。 |
RISK_REJECT | F | 因风险控制,请求被拒绝。 | 提示用户请求被拒绝,因为风险控制失败。 |
SETTLE_CONTRACT_NOT_MATCH | F | 找不到匹配的结算合同。 | 检查以下解决方案:
|
SYSTEM_ERROR | F | 发生系统错误。 | 获取 Antom 技术支持前请勿重试。 |
USER_AMOUNT_EXCEED_LIMIT | F | 支付金额超过了用户的支付限额。 | 使用不超过账户可用余额的金额创建新支付,或联系 Antom 技术支持。 |
USER_BALANCE_NOT_ENOUGH | F | 由于对应支付方式的用户余额不足,支付无法完成。 | 请充值账户或选择其他支付方式。 |
USER_KYC_NOT_QUALIFIED | F | 由于用户的 KYC 状态,支付失败。用户要么未完成 KYC,要么 KYC 状态不满足此交易要求(例如,支付金额或产品信息的限制)。 | 请先完成 KYC 验证。 |
USER_NOT_EXIST | F | 用户在支付方式端不存在。 | 请联系 Antom 技术支持以获取详细原因。 |
USER_PAYMENT_VERIFICATION_FAILED | F | 用户在 OTP、PIN 等验证方式中未能通过支付验证。 | 请联系 Antom 技术支持了解具体原因。 |
USER_STATUS_ABNORMAL | F | 用户在支付方式端的状态异常。 | 请联系 Antom 技术支持了解具体原因。 |
PAYMENT_IN_PROCESS | U | 支付正在处理中。 |
等待异步通知或调用查询支付接口查询最终支付状态。 |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | 请求流量超过限制。 | 再次调用接口来解决问题。如果问题未解决,请联系 Antom 技术支持。 |
UNKNOWN_EXCEPTION | U | 由于未知原因,接口调用失败。 | 调用查询支付接口查询最终支付状态。如果问题未解决,请联系 Antom 技术支持。 |
VERIFY_TIMES_EXCEED_LIMIT | F | 当前验证码在支付验证中失败次数过多。 | 用户必须获取新的验证码。 |
VERIFY_UNMATCHED | F | 验证码无效。 | 用户必须获取新的验证码。 |