VI | EN
Message us on Messenger
Developer resources

This API is applicable for Cross Border (CB) sellers only to get the shop's payout data, such as the payout amount, currency, FX rate, the payout's associated order income and adju — Shopee API

v2.payment.get_payout_detail · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

v2.payment.get_payout_detail

GET/api/v2/payment/get_payout_detailVia 360: GET https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail
Description

CHỈ GIAN HÀNG XUYÊN BIÊN GIỚI (CB), bản CŨ của get_payout_info: đợt chi trả kèm danh sách đơn và điều chỉnh ngoài đơn trong đợt. Gian hàng nội địa Việt Nam không dùng được.

  • Gian hàng nội địa VN nhận error_param "This payment API is only applicable for cross boarder shop". Dùng get_payout_info cho tích hợp mới.

Request

Endpoint

GET https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer q360_live_ab12cd34_…Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_idquerystring100001Gian hàng (lấy ở GET /v1/platforms → shops[].platform_shop_id). BẮT BUỘC khi brand có > 1 gian hàng trên nền tảng; 360 bỏ tham số này trước khi chuyển tiếp.

Request parameters

NameInTypeRequiredSampleDescription
payout_time_fromquerytimestampYes1792990800Chi trả từ (Unix giây) — khoảng tối đa 15 ngày.
payout_time_toquerytimestampYes1793250000Chi trả đến (Unix giây).
page_sizequeryintYes100Tối đa 100.
page_noqueryintYes1Trang, từ 1.

Pagination

Tăng page_no khi response.more = true.

Request examples

curl -s "https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail?payout_time_from=1792990800&payout_time_to=1793250000&page_size=100&page_no=1" \
  -H "Authorization: Bearer $KEY"
Python
import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail",
    params={
        "payout_time_from": 1792990800,
        "payout_time_to": 1793250000,
        "page_size": 100,
        "page_no": 1
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())
Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail');
for (const [k, v] of Object.entries({"payout_time_from":1792990800,"payout_time_to":1793250000,"page_size":100,"page_no":1})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());
PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/shopee/api/v2/payment/get_payout_detail' . '?' . http_build_query(['payout_time_from' => 1792990800, 'payout_time_to' => 1793250000, 'page_size' => 100, 'page_no' => 1]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by Shopee)

NameTypeSampleDescription
request_idstringd52ca43b277a4f9292fb8be658bfd33dMã request của Shopee để tra lỗi.
errorstringMã lỗi Shopee; rỗng = thành công.
messagestringMô tả lỗi.
responseobject
moreboolfalse
payout_listobject[]
payout_infoobjectNhư một phần tử payout_list của get_payout_info (không có encrypted_payout_id).
escrow_listobject[]Đơn trong đợt: {order_sn, escrow_amount, currency}.
offline_adjustment_listobject[]Điều chỉnh ngoài đơn: {adjustment_amount, module, remark, scenario, adjustment_level (shop / order), order_sn}.

Response sample

{
  "error": "error_param",
  "message": "This payment API is only applicable for cross boarder shop",
  "request_id": "bc533aa35ef335fc…"
}

Shopee error codes (10)

Show
CodeMeaning
add_on.add_on_deal_item_under_btocCó sản phẩm B2C không được thêm vào khuyến mãi.
error_dataDữ liệu không tồn tại hoặc không hợp lệ cho thao tác (vd mã không có, loại yêu cầu không cho phép).
error_paramTham số sai / thiếu / sai kiểu — xem `message` để biết tham số nào.
error_serverLỗi hệ thống Shopee — thử lại sau ít phút.
error_shopGian hàng không hợp lệ — kiểm tra platform_shop_id.
error_authỦy quyền gian hàng cho 360 đã hết hạn hoặc bị thu hồi (360 đã tự làm mới token một lần) — chủ gian hàng kết nối lại Shopee trong Partner.
error_limitChạm hạn mức gọi Shopee trong ngày của kết nối — 360 trả kèm thời điểm thử lại; giảm tần suất gọi.
error_rate_limitGọi quá nhanh — chờ vài giây rồi gọi lại (360 cũng giới hạn theo key: 429 + Retry-After).
shop_bannedGian hàng đang bị Shopee khóa — mọi API tạm ngưng tới khi gỡ khóa.
error_kyc_authGian hàng chưa hoàn tất đăng ký người bán trên Kênh Người Bán.

Get started

  1. Sign up for Partner
  2. Enable a data type of the Tài chính / đối soát group on the platform page
  3. Create an API key (tick the Shopee channel)
  4. Call it as in the examples above