获取财务资产组合
您可以使用本接口检索和商务中心属于同一客户的财务资产组合列表。
请求
地址 https://business-api.tiktok.com/open_api/v1.3/payment_portfolio/get/
方法 GET
Header
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。<br>可以通过[获取访问令牌](1738373164380162.html)接口获取。|
参数
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|bc_id {必填}|string|商务中心 ID。<br><br>返回中默认包含和商务中心属于同一客户的财务资产组合列表，即使这些财务资产组合未与商务中心绑定。|
|filtering|object|筛选条件。|
#|payment_portfolio_ids|string[]|用于筛选结果的财务资产组合 ID 列表。<br>最大数量：10。<br>不合法的财务资产组合 ID 将被忽略。|
#|payment_portfolio_type|string|财务资产组合类型。<br><br>枚举值：<ul><li>`SHARED`：高级财务资产组合。</li><li>`NON_SHARED`：标准财务资产组合。</li></ul>|
#|bc_related|boolean|是否仅返回与商务中心关联的财务资产组合。<br><br>支持的值：`true`，`false`。|
|page|integer|当前页数。<br><br>默认值：1。<br>取值范围：≥ 1。|
|page_size|integer|分页大小。<br><br>默认值：10。<br>取值范围：1-50。|
示例
(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/payment_portfolio/get/?bc_id={{bc_id}}&page=1&page_size=50' \
--header 'Access-Token: {{Access-Token}}'
(/code)
返回
|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见[附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志 ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#|payment_portfolio_list|object[]|财务资产组合列表。|
##|payment_portfolio_id|string|财务资产组合的 ID。|
##|payment_portfolio_name|string|财务资产组合的名称。|
##|payment_portfolio_type|string|财务资产组合类型。<br><br>枚举值：<ul><li>`SHARED`：高级财务资产组合。对于高级财务资产组合，资金为集中管理，由所有关联的广告账号共同使用。</li><li>`NON_SHARED`：标准财务资产组合。对于标准财务资产组合，每个关联的广告账号的资金均为单独管理。</li></ul>|
##|linked_advertiser_account_count|number|与该财务资产组合关联的广告账户数量。|
##|user_count|number|有权限访问该财务资产组合的用户数量。|
##|cash_balance_list|[]object|财务资产组合内的现金余额列表。|
###|currency|string|币种。|
###|amount|number|该币种的余额金额。|
##|credit_line_allocation|object|信用额度分配的详细信息。|
###|allocated_amount|number|该财务资产组合分配到的总信用额度金额。|
###|used_amount|number|该财务资产组合已用的信用额度金额。|
###|available_amount|number|该财务资产组合可用的信用额度金额。<br><br>公式：`available_amount` = `allocated_amount` - `used_amount`。|
###|min_allocation_percentage|number|最低分配百分比，保留四位小数。<br>此百分比与财务资产组合已使用的信用额度百分比相同。|
#|page_info|object|分页信息。|
##|page|number|当前页码。|
##|page_size|number|分页大小。|
##|total_number|number|结果总数。|
##|total_page|number|总页数。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"page_info": {
"page": 1,
"page_size": 50,
"total_number": 2,
"total_page": 1
},
"payment_portfolios": [
{
"cash_balance_list": [
{
"amount": 0,
"currency": "USD"
}
],
"credit_line_allocation": {
"allocated_amount": 0,
"available_amount": 0,
"min_allocation_percentage": 0,
"used_amount": 0
},
"linked_advertiser_account_count": 0,
"payment_portfolio_id": "{{payment_portfolio_id}}",
"payment_portfolio_name": "{{payment_portfolio_name}}",
"user_count": 7
},
{
"cash_balance_list": [
{
"amount": 0,
"currency": "USD"
}
],
"credit_line_allocation": {
"allocated_amount": 0,
"available_amount": 0,
"min_allocation_percentage": 0,
"used_amount": 0
},
"linked_advertiser_account_count": 2,
"payment_portfolio_id": "{{payment_portfolio_id}}",
"payment_portfolio_name": "{{payment_portfolio_name}}",
"user_count": 7
}
]
}
}
(/code)