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.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/get_payout_info
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 |
|---|---|---|---|---|
| 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. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| request_id | string | 10fff653c945a390f8e1323c6bdffff4 | The identifier for an API request for error tracking. |
| response | object | ||
| payout_list | object | ||
| from_currency | string | SGD | The settlement currency of orders. |
| payout_currency | string | USD | The actual currency of payout. |
| from_amount | float | 1769.01 | The settlement amount. |
| payout_amount | float | 1769.01 | The actual amount of payout. |
| exchange_rate | string | "1" | The exchange rate. |
| payout_time | timestamp | 1691050374 | 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. |
| 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 |