Antom, leading provider of tailored payment solutions

retrievePaymentSession

POST /v1/payments/retrievePaymentSession

支付完成后使用此接口检索交易详情,包括最终数量、价格、折扣、促销和自定义数据。

结构

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

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

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


入参

paymentRequestId String  

商户支付请求 ID。由商户分配的唯一标识符,用于识别特定的支付请求。

注意:paymentRequestId 与 paymentSessionId 不能同时为空。若两者同时指定,系统将优先以 paymentSessionId 为准。

更多信息:

  • 最大长度:64 字符

paymentSessionId String  

支付会话加密 ID。由 APO 分配的加密标识符,用于识别特定的支付会话

注意:paymentRequestId 与 paymentSessionId 不能同时为空。若两者同时指定,系统将优先以 paymentSessionId 为准。

更多信息:

  • 最大长度:64 字符

出参

result Result  REQUIRED

接口调用的结果。

order Order  

订单信息。

注意:在 CKP 和 ELEMENT 场景下返回。

API Explorer

请求

URL
Method
POST
json
{
  "paymentSessionId": "PAYMENT_SESSIONID_20260129144822724_AUTO"
}

响应

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  },
  "order": {
    "goods": [
      {
        "goodsQuantity": "2",
        "goodsUnitAmount": {
          "currency": "CNY",
          "value": "10"
        },
        "goodsDiscountAmount": {
          "currency": "CNY",
          "value": "5"
        },
        "referenceGoodsId": "amsdm_good_tony_c_20230227_095825_922"
      }
    ],
    "orderAmount": {
      "currency": "CNY",
      "value": "20"
    },
    "shipping": {
      "shipToEmail": "pen***@amsdm.com",
      "shippingAddress": {
        "address1": "**************",
        "address2": "yellow dragon E",
        "city": "hangzhou",
        "region": "CN",
        "state": "Zhejiang",
        "zipCode": "310000"
      },
      "shippingCarrier": "EMS",
      "shippingName": {
        "firstName": "*****",
        "fullName": "D***u",
        "lastName": "Liu",
        "middleName": "Skr"
      },
      "shippingPhoneNo": "+86183******78"
    }
  }
}

结果/错误代码

resultCode

resultStatus

resultMessage

处理建议

SUCCESS

S

接口调用成功。

无需进一步操作。

UNKNOWN_EXCEPTION

U

API 调用失败,原因未知。

请重新调用接口以解决该问题。如果问题仍未解决,请联系 APO 技术支持。

PROCESS_FAIL

F

发生了一般业务失败。

建议联系 APO 技术支持以排查该问题