createPaymentSession（快捷支付）

2026-07-02 16:38

POST /v1/payments/createPaymentSession

此接口用于生成客户端 SDK 集成的支付会话。接口响应提供加密的会话数据，可用于初始化客户端 SDK。这个 SDK 简化了支付流程，使您无需手动调用多个接口。

结构

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

注意：将每个参数（除数组外）的数据类型设置为字符串，即参数的值必须使用英文双引号（" "）包裹起来。例如：

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

入参

env Env

下单的环境信息。

order Order REQUIRED

包括买家、商户、商品、金额、配送信息和购买环境的订单信息。此字段用于以下目的：

在支付过程中，此字段主要用于 Antom 的风险控制或反洗钱。
支付完成后，此字段用于记录和报告，如采购追踪和监管报告。

paymentRequestId String REQUIRED

商户为识别支付请求而分配的专属 ID。

更多信息：

最大长度：64 字符

paymentAmount Amount REQUIRED

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

settlementStrategy SettlementStrategy REQUIRED

支付请求的结算策略。

paymentMethod PaymentMethod REQUIRED

商家或收单机构用于收取支付的支付方式。

agreementInfo AgreementInfo

快捷支付的授权信息。

注意：仅在首次快捷支付时指定此参数以获取访问令牌。

paymentSessionExpiryTime Datetime

支付会话过期的特定日期和时间。默认过期时间为会话创建后 1 小时。例如，如果会话在 2023-7-27T12:00:01+08:30 创建，那么会话过期时间为 2023-7-27T13:00:01+08:30。

注意：如果要使用不同于默认时间的支付会话过期时间，请指定此参数。指定的过期时间必须在会话创建后 0 到 1 小时之间。

更多信息：

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

paymentNotifyUrl URL REQUIRED

用于接收支付结果通知的链接。

更多信息：

最大长度：2048 字符

paymentRedirectUrl URL REQUIRED

支付完成后用户被重定向到的商户页面链接。

注意：当 paymentMthodType 的值为 PAYPAY 时，该参数最大长度为 255。

更多信息：

最大长度：2048 字符

productCode String REQUIRED

表示正在使用的支付产品。值设置为AGREEMENT_PAYMENT。

productScene String REQUIRED

值设置为EASY_PAY，表示快捷支付。

更多信息：

最大长度：32 字符

paymentExpiryTime Datetime

交易的超时时间，Antom 确认订单后由此字段指定超时时间，不指定则使用 Antom 默认超时时间。

更多信息：

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

出参

result Result REQUIRED

接口调用的结果。如果此接口调用成功，支付会话创建成功。

paymentSessionId String REQUIRED

Antom 为识别支付会话而分配的加密 ID。

更多信息：

最大长度：64 字符

paymentSessionData String REQUIRED

加密的支付会话数据。将数据传递给前端以初始化客户端 SDK。

更多信息：

最大长度：4096 字符

paymentSessionExpiryTime Datetime REQUIRED

支付会话的过期日期和时间。

更多信息：

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

API Explorer

请求

URL

Method

POST

Case

{
  "env": {
    "osType": "ANDROID",
    "terminalType": "APP"
  },
  "agreementInfo": {
    "authState": "authState_293111782543453",
    "userLoginId": "852-91234567"
  },
  "order": {
    "buyer": {
      "referenceBuyerId": "yourBuyerId"
    },
    "orderAmount": {
      "currency": "USD",
      "value": "98080"
    },
    "orderDescription": "antom api testing order",
    "referenceOrderId": "1a57b8cd-9a25-4d44-94f7-3467a4ebe532"
  },
  "paymentAmount": {
    "currency": "USD",
    "value": "98080"
  },
  "paymentMethod": {
    "paymentMethodType": "ALIPAY_HK",
    "paymentMethodId": "28288803002561481743389798000V30mFAqYku171000049"
  },
  "paymentNotifyUrl": "http://www.yourNotifyUrl.com",
  "paymentRedirectUrl": "http://www.yourRedirectUrl.com",
  "paymentRequestId": "paymentRequestId_2111197385743854",
  "productCode": "AGREEMENT_PAYMENT",
  "productScene": "EASY_PAY",
  "settlementStrategy": {
    "settlementCurrency": "USD"
  }
}

响应

{
  "paymentSessionData": "UNvjVWnWPXJA4BgW+vfjsQj7PbOraafHY19X+6EqMz6Kvvmsdk+akdLvoShW5avHX8e8J15P8uNVEf/PcCMyXg==&&SG&&111",
  "paymentSessionExpiryTime": "2023-04-06T03:28:49+08:00",
  "paymentSessionId": "UNvjVWnWPXJA4BgW+vfjsQj7PbOraafHY19X+6EqMz6Ikyj9FPVUOpv+DjiIZqMe",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  }
}

结果码

结果码	值	结果码信息	行动建议
SUCCESS	S	成功	支付会话已成功创建。无需进一步操作。
PARAM_ILLEGAL	F	缺少必需的参数，或者存在非法参数。例如，非数字输入，无效的日期，或者参数的长度和类型错误。	检查并验证当前接口所需的请求字段（包括头部字段和正文字段）是否正确传递并有效。
PROCESS_FAIL	F	发生了常见的业务失败。	获取 Antom 技术支持前请勿重试。
UNKNOWN_EXCEPTION	U	由于未知原因，接口调用失败。	重新调用接口以解决问题。如果问题未解决，请联系 Antom 技术支持。