宠物商店

获取支付集合

正式环境

GET

/store/payment-collections/{id}

Store API/Payment CollectionsPayment Collections

检索支付集合的详细信息。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://apifoxmock.com/m1/4997831-4656773-default/store/payment-collections/'

响应示例

200 - 示例 1

请求参数

Path 参数

string

必需

PaymentCollection 的ID。

Query 参数

fields

string

可选

应在返回的付款集合中扩展的逗号分隔字段。

expand

string

可选

应在返回的付款集合中扩展的逗号分隔关系。

返回响应

🟢200正常

application/json

Body

付款集合的详细信息。

payment_collection

object (Payment Collection)

必需

付款集合允许对付款列表进行分组和管理。在为订单编辑进行额外付款或集成分期付款时，这可能会有所帮助。

string

付款集合的ID

必需

示例值:

paycol_01G8TJSYT9M6AVS5N4EMNFS1EK

description

string | null

付款集合的描述

必需

amount

integer

付款集合的金额。

必需

authorized_amount

integer | null

必需

付款集合的授权金额。

region_id

string

必需

此付款集合关联的地区的 ID。

示例值:

reg_01G1G5V26T9H8Y0M4JNE3YGA4G

created_by

string

必需

创建付款集合的用户的 ID。

created_at

string <date-time>

必需

资源创建时间（含时区）。

updated_at

string <date-time>

必需

资源更新时间（含时区）。

deleted_at

string <date-time> | null

必需

资源删除时间（含时区）。

type

enum<string>

付款集合的类型

必需

枚举值:

order_edit

status

enum<string>

付款集合的类型

必需

枚举值:

not_paidawaitingauthorizedpartially_authorizedcanceled

currency_code

string

必需

此付款集合关联的货币的三个字符 ISO 代码。

示例值:

usd

metadata

object | null

必需

包含其他详细信息的可选键值映射

示例值:

{"car":"white"}

currency

object (Currency)

货币

可选

payments

array[object (Payment) {19}]

可选

作为付款集合的一部分创建的付款的详细信息。

region

object (Region)

可选

地区包含特定于地理位置的设置，包括货币、税率以及配送和支付提供程序。一个地区可以包含多个国家，以适应跨国界的常见购物设置。

payment_sessions

array[object (Payment Session) {13}]

可选

作为付款集合的一部分创建的支付会话的详细信息。

🟠400客户端错误或多个错误

🟠401用户未授权。必须先登录

🟠404未找到错误

🟠409无效状态错误

🟠422无效请求错误

🔴500服务器错误

修改于 2024-09-20 08:34:42

刷新支付会话

管理支付会话