v2.payment.get_escrow_list
GET /api/v2/payment/get_escrow_list
Use this API to fetch the accounting list of order.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/get_escrow_list
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 |
|---|---|---|---|---|
| release_time_from | timestamp | True | 1651680000 | Query start time |
| release_time_to | timestamp | True | 1651939200 | Query end time |
| page_size | int32 | False | 40 | Number of pages returned max:100 default:40 |
| page_no | int32 | False | 1 | The page number min:1 default:1 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | 8d7de8c04b4cd5f3df9e4aa98c2d87d1 | The identifier for an API request for error tracking. |
| response | object | The business content of the response | |
| escrow_list | object[] | The list of escrow order sn. | |
| order_sn | string | 220415N6SB140P | Shopee's unique identifier for an order. |
| payout_amount | float | 5733.04 | The settlement amount |
| escrow_release_time | timestamp | 1651849648 | The release time |
| more | boolean | true | This is to indicate whether the escrow list is more than one page. If this value is true, you may want to continue to check next page to retrieve escrow orders. |