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

咨询

POST /v1/payments/consult

使用此接口向 Antom 发起支付咨询请求。此请求会为您返回关于不同支付方式、对应金额、国家、货币、规则和配置的信息。

此接口可以实现以下功能：

  • 为消费者提供多种支付方式，而不承担因这些支付方式变化而产生的额外成本，或管理选择和排序这些支付方式的逻辑。
  • 自动化选择和排序多种支付方式。

结构

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


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

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

入参

merchantRegion String  

商户开展业务的国家或地区。此参数是遵循 ISO 3166 国家代码标准的二位字母国家或地区代码。

可能的值包括 US, SG, HK, PK, JP, CN, BR, AU, 和 MY。 

注意：当您使用全球收单网关（GAGW）产品时，此参数是必需的。

更多信息：

  • 最大长度：2 字符

merchantAccountId String  

用于识别商户账户的专属 ID。

注意：当您在多个地点使用同一个客户端 ID 时，需要指定此参数。

更多信息：

  • 最大长度：32 字符

userRegion String  

二位国家或地区代码。更多信息，请参阅 ISO 3166 国家代码标准。 支付方式将根据给定用户所在地区的支付方式相关性进行排序。 

更多信息：

  • 最大长度：2 字符

allowedPaymentMethodRegions Array<String>  

支付方式所属国家或地区的代码列表。此参数的值为二位字母的 ISO 国家代码或GLOBAL。 

注意：如果您希望返回特定地区的可用支付方法，请指定此参数。例如，如果传入GLOBAL，则返回全球可用的维萨卡（Visa）和万事达卡（Mastercard）。  

更多信息：

  • 最大长度：6 字符

buyer Buyer object 

买家信息。

Show child parameters

env Env object REQUIRED

下单环境的信息，如设备信息。

Show child parameters

paymentAmount Amount object REQUIRED

商户请求在订单货币中接收的支付金额。

Show child parameters

settlementStrategy SettlementStrategy object 

结算策略。

Show child parameters

paymentFactor PaymentFactor object 

影响支付的因素。此字段用于指示支付场景。

注意：当 paymentMethodType 的值为CARD时指定此参数。

Show child parameters

productCode String  REQUIRED

表示正在使用的支付产品。可使用的支付产品在合同中有规定。固定值为：

  • CASHIER_PAYMENT: 表示此接口用于收银台支付场景。

更多信息：

  • 最大长度：32 字符

出参

result Result object REQUIRED

包含状态和错误代码等信息的请求结果。

注意：此字段不表示支付结果。此字段仅表示咨询接口是否调用成功。

Show child parameters

paymentOptions Array<PaymentOption> object 

支付选项列表。

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

请求

URL

请求体

响应

响应体

结果码

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

咨询成功。无需进一步操作。

CURRENCY_NOT_SUPPORTF货币不受支持。

更改请求中使用的货币。如果问题仍然存在，请联系 Antom 技术支持以获取详细原因。

MERCHANT_NOT_REGISTEREDF商户未注册。

请使用注册接口注册商户。如果无法调用注册接口，请联系 Antom 技术支持。 

NO_PAY_OPTIONSF没有可用的支付选项。

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

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

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

PROCESS_FAILF发生了常见的业务失败。

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

SETTLE_CONTRACT_NOT_MATCHF找不到匹配的结算合同。

尝试以下解决方案：

  1. 从商户签约的多种货币中指定一种结算货币。
  2. 确认结算货币是否在结算合同中明确指定。
  3. 商户未签署结算合同。请联系 Antom 技术支持。
UNKNOWN_EXCEPTIONU由于未知原因，接口调用失败。

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