Significant OpenAPI Updates of Payment

资料正文

§1 Significant OpenAPI Updates of Payment

Dear Developers

Please find below the OpenAPI updates released this time. These changes aim to enhance functionality, improve flexibility, and provide better integration support.

§2 1. [BR] Payment APIs Add Buyer Instant Service Fee Field

1. [BR] Payment APIs Add Buyer Instant Service Fee Field

Background

To support the BR Instant channel business, Shopee will charge buyers a Buyer Instant Service Fee for orders containing instant items. This fee is paid by the buyer at checkout and fully retained by the platform. It will not be included in the seller’s escrow, income calculation, or payout.

To ensure transparent amount display, Payment OpenAPIs will add the Buyer Instant Service Fee field to help developers identify the Instant Service Fee amount paid by buyers.

Applicable Scope

BR local shops

Update Details

v2.payment.get_escrow_detail /v2.payment.get_escrow_detail_batch will adjust the following fields to display the Instant Service Fee information paid by buyers.

Field	Type	Description
buyer_payment_info > buyer_instant_fee	New Response Field	Service fee amount paid by the buyer for an instant order.

Note:

Buyer Instant Service Fee is displayed only as buyer payment information and does not affect the seller’s escrow, income calculation, or payout.

When the value of buyer_instant_fee is 0, the APIs will still return this field with the value as 0.

Please adjust your Payment API parsing, buyer payment amount display, and financial reconciliation logic based on the new field.

Related APIs

v2.payment.get_escrow_detail

v2.payment.get_escrow_detail_batch

Effective Date

Lived

尊敬的开发者

请查收本次的 OpenAPI 功能更新。这些改动旨在提升功能灵活性、优化使用体验,并为集成提供更好的支持。

§3 1. [BR] Payment 接口新增 Buyer Instant Service Fee 字段

1. [BR] Payment 接口新增 Buyer Instant Service Fee 字段

背景

为支持 BR Instant channel 业务, Shopee 将针对包含 instant item 的订单向买家收取 Buyer Instant Service Fee。该费用由买家在checkout 时支付, 100% 由平台保留,不计入卖家的 escrow、收入计算或 payout。

为保证金额展示透明, Payment 相关 OpenAPI 将新增 Buyer Instant Service Fee 字段,帮助开发者识别买家支付的 Instant Service Fee 金额。

适用范围

BR local shops

更新内容

v2.payment.get_escrow_detail /v2.payment.get_escrow_detail_batch 将调整以下字段,用于展示买家支付的 Instant Service Fee 信息。

Field	Type	Description
buyer_payment_info > buyer_instant_fee	New Response Field	买家为 Instant 订单支付的服务费金额。

Note:

Buyer Instant Service Fee 仅作为买家支付信息展示,不影响卖家的 escrow、收入计算或 payout。

当 buyer_instant_fee 字段值为0时,接口仍会返回该字段,字段值为0。

请开发者根据新增字段调整 Payment 接口解析、买家支付金额展示及财务对账逻辑。