v2.payment.get_payout_info
GET /api/v2/payment/get_payout_info
This is a new API which applicable for Cross Border (CB) sellers only to get the shop's payout data, will be used for the original API v2.get_payout_details replacement, we provide data such as the payout amount, currency, FX rate, the payout's associated order income and adjustment records etc.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/payment/get_payout_info
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo từ partner_id, đường dẫn api, timestamp, access_token, shop_id và partner_key qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| payout_time_from | timestamp | True | 1643365068 | Start time. Maximum time range is 15 days |
| payout_time_to | timestamp | True | 1659003469 | Payout End time |
| page_size | int | True | 10 | Number of pages returned max:100 |
| cursor | string | True | "" | Specifies the starting entry of data to return in the current call. Default is "". If data is more than one page, the offset can be some entry to start next call. |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| message | string | Cho biết chi tiết lỗi nếu xảy ra. Trống nếu không có lỗi. | |
| error | string | Cho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi. | |
| request_id | string | 10fff653c945a390f8e1323c6bdffff4 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| response | object | ||
| payout_list | object | ||
| from_currency | string | SGD | Đơn vị tiền tệ thanh toán của các đơn hàng. |
| payout_currency | string | USD | Đơn vị tiền tệ thực tế của khoản thanh toán. |
| from_amount | float | 1769.01 | Số tiền thanh toán. |
| payout_amount | float | 1769.01 | Số tiền thực tế được chi trả. |
| exchange_rate | string | "1" | Tỷ giá hối đoái. |
| payout_time | timestamp | 1691050374 | Thời gian chi trả. |
| pay_service | string | Payoneer | Nhà cung cấp dịch vụ của người bán. Giá trị khả dụng: payoneer, pingpong, lianlian. |
| payee_id | string | "279016275538" | Seller's account to receive the payout. |
| encrypted_payout_id | string | "16061973102097436445" | payout id used to query API "v2.get_billing_item_info" as request parameters. User can get detailed billing items under current payout |
| more | boolean | false | True or False |
| next_cursor | string | "" | used for next batch data query. will return empty when all data been returned |