咨询
使用此接口向 Antom 发起支付咨询请求。该请求会为您返回关于不同支付方式及其对应限额、国家、货币、规则和配置的信息。
此接口可以实现以下功能:
- 为消费者提供多种支付方式,而无需承担因这些支付方式变化更产生的额外成本,也不需要管理选择和排序这些支付方式的逻辑。
- 自动化选择和排序多种支付方式。
入参
merchantRegion String
商户开展业务的国家或地区。此参数是遵循 ISO 3166 国家代码标准的二位字母国家或地区代码。
可能的值包括 US
, SG
, HK
, PK
, JP
, CN
, BR
, AU
, 和 MY
。
注意:当您使用全球收单网关(GAGW)产品时,此参数是必需的。
更多信息:
- 最大长度:2 字符
merchantAccountId String
用于识别商户账户的专属 ID。
注意:当您在多个地点使用同一个客户端 ID 时,需要指定此参数。
更多信息:
- 最大长度:32 字符
allowedPaymentMethodRegions Array<String>
支付方式所属国家或地区的代码列表。此参数的值为二位字母的 ISO 国家代码或GLOBAL
。
注意:如果您希望返回特定地区的可用支付方法,请指定此参数。例如,如果传入
GLOBAL
,则返回全球可用的维萨卡(Visa)和万事达卡(Mastercard)。
更多信息:
- 最大长度:6 字符
buyer Buyer
买家信息。
env Env REQUIRED
下单环境的信息,如设备信息。
paymentAmount Amount REQUIRED
商户请求在订单货币中接收的支付金额。
settlementStrategy SettlementStrategy
结算策略。
paymentFactor PaymentFactor
影响支付的因素。此字段用于指示支付场景。
注意:当 paymentMethodType 的值为
CARD
时指定此参数。
productCode String REQUIRED
表示正在使用的支付产品。可使用的支付产品在合同中有规定。固定值为:
CASHIER_PAYMENT
: 表示此接口用于收银台支付场景。
更多信息:
- 最大长度:32 字符
出参
result Result REQUIRED
包含状态和错误代码等信息的请求结果。
注意:此字段不表示支付结果。此字段仅表示咨询接口是否调用成功。
paymentOptions Array<PaymentOption>
支付选项列表。
请求
响应
结果码
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | 成功 | 咨询成功。无需进一步操作。 |
CURRENCY_NOT_SUPPORT | F | 货币不受支持。 | 更改请求中使用的货币。如果问题仍然存在,请联系 Antom 技术支持以获取详细原因。 |
MERCHANT_NOT_REGISTERED | F | 商户未注册。 | 请使用注册接口注册商户。如果无法调用注册接口,请联系 Antom 技术支持。 |
NO_PAY_OPTIONS | F | 没有可用的支付选项。 | 请联系 Antom 技术支持以获取详细原因。 |
PARAM_ILLEGAL | F | 缺少必需的参数,或者存在非法参数。例如,非数字输入,无效的日期,或者参数的长度和类型错误。 | 检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。 |
PROCESS_FAIL | F | 发生了常见的业务失败。 | 获取 Antom 技术支持前请勿重试。 |
SETTLE_CONTRACT_NOT_MATCH | F | 找不到匹配的结算合同。 | 尝试以下解决方案:
|
UNKNOWN_EXCEPTION | U | 由于未知原因,接口调用失败。 | 再次调用接口解决问题。如果问题仍未解决,请联系 Antom 技术支持。 |