v2.payment.get_payout_detail

GET /api/v2/payment/get_payout_detail

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 adjustment records etc.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/payment/get_payout_detail

Common Request Parameters

Name	Type	Sample	Description
partner_id	int	1	Partner ID is assigned upon registration is successful. Required for all requests.
timestamp	timestamp	1610000000	This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_token	string	c09222e3fc40ffb25fc947f738b1abf1	The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_id	int	600000	Shopee's unique identifier for a shop. Required param for most APIs.
sign	string	e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2	Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2

Request Parameters

Name	Type	Required	Sample	Description
page_size	int	True	10	Number of pages returned max:100
page_no	int	True	1	The page number min:1 default:1
payout_time_from	timestamp	True	1643365068	Strat time. Maximum time range is 15 days
payout_time_to	timestamp	True	1659003469	End time

Response Parameters

Name	Type	Sample	Description
error	string		Error code
message	string		Error message
request_id	string	5bd2a33faed0007f4883797f590e2a26	The unique id for request.
response	object		The business content of the response
more	boolean	false
payout_list	object[]
payout_info	object		The information of payout.
from_currency	string	VND	The settlement currency of orders.
payout_currency	string	USD	The actual currency of payout.
from_amount	float	591797912.0	The settlement amount.
payout_amount	float	25678.64	The actual amount of payout.
exchange_rate	string	0.00	The exchange rate.
payout_time	timestamp	1651842208	The time of payout.
pay_service	string	Payoneer	The service provider of seller. Available value: payoneer, pingpong, lianlian.
payee_id	string	279016275538	Seller's account to receive the payout.
escrow_list	object[]
escrow_amount	float	20865.0	The total amount that the seller is expected to receive for the order.
currency	string	VND	The currency used for calculating escrow amount.
order_sn	string	220404NF3CFFNY	Shopee's unique identifier for an order.
offline_adjustment_list	object[]		The list of offline adjustments.
adjustment_amount	float	2.0	The amount of offline adjustments.
module	string	Commission Fee	The reason for offline adjustment.
remark	string	DRC commission fee adjustment	The remark for the reason.
scenario	string	Commission Fee Adjustment	The scenario of adjustment.
adjustment_level	string	shop	Dimension of offline adjustment. Available value: shop, order.
order_sn	string	220322JUMMT0S0	Shopee's unique identifier for an order.