en zh

Samsung IAP Orders API

Samsung 应用程序内购买 (IAP) Orders API 用于查看特定日期的所有付款和退款。在开始使用 IAP Orders API 之前，必须满足所有要求并在请求中使用规定的授权头参数。请参阅 开始使用 Samsung IAP API，了解详细信息。

查看付款和退款

查看特定日期的所有付款和退款。

请求

POST /iap/seller/orders

名称	类型	说明
sellerSeq	string	必需。您的卖家门户中的卖家深层链接，由 12 位数字组成。 要查找您的卖家深层链接，请登录卖家门户，并转到 个人资料 > 产品页面的开发者信息.
packageName	string	可选. 您要查看其付款和退款数据的应用程序的程序包名称。如果未指定 packageName，则返回所有应用程序的数据。 要查找应用程序的程序包名称，请登录“卖家门户”，转到“应用程序”，选择应用程序，打开“二进制文件”选项卡，然后单击文件名。
requestDate	string	可选. 您要查看的付款和退款的特定日期。如果未指定日期，则使用昨天的日期。 格式: yyyymmdd
continuationToken	string	可选. 请求获取下一页付款/退款数据（每页包含 100 项）。如果未指定 continuationToken，则显示第一页数据。 如果有多页数据可用，则响应中将包含 continuationToken。使用此令牌请求获取下一页数据。如果响应中返回的 continuationToken 为空，这表明上一页数据是含有项目信息的最后一页。

curl \
  -X POST \
  -H "content-type:application/json" \
  -H "Authorization: Bearer <your-access-token>" \
  -H "service-account-id: <your-service-account-id>" \
  -d '{"sellerSeq":"000123456789","packageName":"com.samsung.android.sample","requestDate":"20230615","continuationToken":"e5ec039730164c50277f9a231b74c1b6e035d9184160d8b3d6b3de1f62691328fbe4c0c4863da52b3bcecef44a4c7acb974c674728c3cb173cb339bd41783f2c"}' \
  "https://devapi.samsungapps.com/iap/seller/orders"

用例

包含的参数	获取的数据
sellerSeq	所有应用程序昨天的付款和退款。
sellerSeq, packageName	指定应用程序昨天的付款和退款。
sellerSeq, requestDate	指定日期所有应用程序的付款和退款。
sellerSeq, packageName, requestDate	指定日期指定应用程序的付款和退款。

响应

参数

名称	类型	说明
continuationToken	string	如果有多页数据（超过 100 项）可供查看，则会发送 continuationToken，以请求和查看下一页数据。如果 continuationToken 为空，这表明上一页数据是含有项目信息的最后一页。
orderId	string	分配给购买收据的唯一标识符。
purchaseId	string	应用程序内项目购买交易的唯一标识符。
contentId	string	在卖家门户中注册的应用程序的内容 ID。
countryId	string	将销售项目的国家/地区的三字符国家/地区代码 (ISO 3166)。
packageName	string	在卖家门户中注册的应用程序的程序包名称。
itemId	string	在卖家门户中注册的应用程序内项目的唯一标识符。
itemTitle	string	在卖家门户中注册的应用程序内项目的标题。
status	string	订单状态。 2: 已成功完成付款 3: 已取消付款（退款） 如果您要测试“已取消付款”状态，请联系客户支持：Seller Portal > 客户支持 > 联系我们  > 联系客户中心. 提供购买交易的 orderId，以便我们可以将订单状态更改为“已取消付款”。
orderTime	datetime	请求获取订单时的时间戳 (UTC)。
completionTime	datetime	成功完成付款时的时间戳 (UTC)。
refundTime	datetime	管理员取消付款时的时间戳 (UTC)。
localCurrency	string	购买项目的国家/地区所用货币的货币符号（例如，$）。
localCurrencyCode	string	T购买项目的国家/地区所用货币的货币代码，由三个字符组成 (ISO 4217)。例如，EUR，GBP，USD。
localPrice	string	以购买项目的国家/地区所用货币表示的项目价格。
usdPrice	string	美元价格 (USD)。
exchangeRate	string	购买时的美元汇率。
mcc	string	SIM 卡国家/地区代码。
subscriptionOrderId	string	如果购买的项目是订阅项目，则为订阅的原始订单 ID。
freeTrialYN	string	是否是在免费试用期购买的项目。 Y: 是在免费试用期购买的项目。 N: 不是在免费试用期购买的项目。
tieredSubscriptionYN	string	是以较低等级/初始优惠订阅还是常规等级/常规订阅购买的项目。 Y: 以较低等级或初始优惠订阅购买的项目。 N: 以常规等级或常规订阅购买的项目。

{
  "continuationToken": "5b5496f44417c9f6b42c8768cbd3f5b5621cdd4021308af81c1e49b77602e9074ab",
  "orderItemList": [
    {
      "orderId": "S20230210KR01922227",
      "purchaseId": "a778b928b32ed0871958e8bcfb757e54f0bc894fa8df7dd8dbb553c81b048343",
      "contentId": "000005059222",
      "countryId": "USA",
      "packageName": "com.samsung.android.sample"
      ...
    },
    {
      "orderId": "S20230210KR01922227",
      "purchaseId": "90a5df78f7815623eb34f567eb0413fb0209bb04dad1367d7877edfa136321",
      "contentId": "000005059222",
      "countryId": "USA",
      "packageName": "com.samsung.android.sample"
      ...
    },
    ...
  ]
}

有关请求失败时可能的响应代码列表，请参阅 失败响应代码。

失败响应代码

下面是请求失败时可能会显示的响应代码。

状态	代码和消息
400 错误请求	SLR_4001: 卖家不匹配 SLR_4009: 继续令牌无效 SLR_4010: 解密的继续令牌包含无效的数据类型 SLR_4011: 日期格式无效。请使用格式 yyyymmdd
401 未授权	SLR_4008: 验证网关服务器授权失败