inquireExchangeRate

POST /v1/payments/inquireExchangeRate

汇率查询接口用于查询支付货币与所有支持货币之间的汇率。

入参

productCode String  REQUIRED

表示合同中规定的正在使用的支付产品。可能的值包括:

  • CASHIER_PAYMENT: 表明合同中规定的正在使用的支付产品是单笔支付产品。
  • AGREEMENT_PAYMENT: 表明合同中规定的正在使用的支付产品是代扣产品。

更多信息:

  • 最大长度:64 字符

buyCurrency String  REQUIRED

购汇币种,即买家向商户支付过程中的商品标价币种。值为遵循 ISO 4217 标准的三位币种代码。

更多信息:

  • 最大长度:3 字符

sellCurrency String  REQUIRED

售汇币种,即买家向商户支付过程中的买家支付币种。值为遵循 ISO 4217 标准的三位币种代码。

更多信息:

  • 最大长度:3 字符

rateType String  

汇率类型。当商户未传入该参数时,默认值为 TRADE。有效值为:

  • TRADE表示汇率类型为交易汇率。
  • REFERENCE_TRADE表示汇率类型为参考交易汇率。
  • REFERENCE表示汇率类型为参考汇率。

更多信息:

  • 最大长度:64 字符

currencyPairs Array<CurrencyPair>  

支持的货币对列表,每次最多可支持 100 组。

Show child parameters

出参

result Result  REQUIRED

接口调用结果。

注意:此字段不代表汇率结果,仅表示本接口是否调用成功。

Show child parameters

paymentQuotes PaymentQuotes  

可直接用于乘法计算的汇率列表,支持多个货币对。

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

请求

URL
Method
POST
请求体

响应

响应体

结果/错误码

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

无需进一步操作。

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

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

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

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

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

请勿重试。通常需要人工干预。建议您联系Antom技术支持以排除问题。

CURRENCY_NOT_SUPPORTF货币不支持。

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