stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 v2.payment.get_wallet_transaction_list
Use this API to get the transaction records of wallet. Only applicable for local shops
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Payment |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/payment/get_wallet_transaction_list |
| Production URL | https://partner.shopeemobile.com/api/v2/payment/get_wallet_transaction_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/payment/get_wallet_transaction_list |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Accounting And Finance; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| page_no | int | Yes | Specifies the starting entry of data to return in the current call. Default is 0. if data is more than one page, the offset can be some entry to start next call. | |
| page_size | int | Yes | If many transactions are available to retrieve, you may need to call GetTransactionList multiple times to retrieve all the data. Each result set is returned as a page of entries. Default is 40. Use the Pagination filters to control the maximum number of entries (<= 100) to retrieve per page (i.e., per call), the offset number to start next call. This integer value is usUed to specify the maximum number of entries to return in a single ""page"" of data. | |
| create_time_from | int | No | The create_time_from field is the starting date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days. | |
| create_time_to | int | No | The create_time_to field is the ending date range. The maximum date range that may be specified with the create_time_from and create_time_to fields is 15 days. | |
| wallet_type | string | No | This field indicates the wallet type. | |
| transaction_type | string | No | Transaction type APIs: ESCROW_VERIFIED_ADD = 101; // Escrow has been verified and paid to seller; ESCROW_VERIFIED_MINUS = 102; // Escrow has been verified and charged from seller as escrow amount is negative; WITHDRAWAL_CREATED = 201; // The seller has created a withdrawal, so it’s deducted from balance; WITHDRAWAL_COMPLETED = 202; // The withdrawal has been completed, so the ongoing amount decreases.; WITHDRAWAL_CANCELLED = 203; // The withdrawal has been canceled, so the amount is added back to the seller balance. Ongoing amount decreases as well.; ADJUSTMENT_ADD = 401; // One adjustment item has been paid to seller ADJUSTMENT_MINUS = 402; // One adjustment item has been charged from seller FBS_ADJUSTMENT_ADD = 404; //One adjustment item related to Shopee fulfillment order is added to seller; FBS_ADJUSTMENT_MINUS = 405; // One adjustment item related to Shopee fulfillment order is deducted from seller; ADJUSTMENT_CENTER_ADD = 406; // One adjustment item has been added to seller wallet ADJUSTMENT_CENTER_DEDUCT = 407; // One adjustment item has been deducted from seller wallet; FSF_COST_PASSING_DEDUCT = 408; FSF cost passing for canceled/invalid orders PERCEPTION_VAT_TAX_DEDUCT = 409; Extra charge for perception regime VAT tax (Argentina) PERCEPTION_TURNOVER_TAX_DEDUCT = 410; Extra charge for perception regime turnover tax (Argentina); PAID_ADS_CHARGE = 450; // Paid ads are charged from seller; PAID_ADS_REFUND = 451; // Paid ads are refunded to seller; FAST_ESCROW_DISBURSE = 452; // ADD. // The first disbursement of fast escrow has been paid to seller; AFFILIATE_ADS_SELLER_FEE = 455; // DEDUCT // Affiliate ads seller fee is charged from seller AFFILIATE_ADS_SELLER_FEE_REFUND = 456; // ADD // Affiliate ads seller fee is refunded to seller; FAST_ESCROW_DEDUCT = 458; // Fast escrow is deducted from seller balance in the event of return and refund; FAST_ESCROW_DISBURSE_REMAIN = 459; // The second disbursement of fast escrow has been paid to seller; AFFILIATE_FEE_DEDUCT = 460; // Affiliate MKT fee is charged from seller for using affiliate MKT services | |
| money_flow | string | No | It's to indicate whether user wants to only return : MONEY_IN = addition MONEY_OUT = Deduction; if not specified, we will return all; Note special case for TW JKO Pay, we will ignore Money_flow | |
| transaction_tab_type | string | No | NOTE: Only 1 'transaction tab type' value should be passed in.; Passing in more than 1 value (eg: comma separated values) will return default response. This is because the request param treats the value passed in as a single string.; This to indicates the updated filtering type that client can use to specify which transaction type we want to return. it will have : Default wallet_order_income wallet_adjustment_filter; wallet_wallet_payment; wallet_refund_from_order; wallet_withdrawals; fast_escrow_repayment; fast_pay; seller_loan corporate_loan pix_transactions_filter; open_finance_transactions_filter Note for BR, wallet txn type that linked to pix_transactions_filter and open_finance_transactions_filter are classified as default type tab instead. therefore for Open API client who wants to query these 2 trx can put default as the filter in this type |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| response | object | |||
| response.transaction_list | object[] | |||
| response.transaction_list.status | string | The status of the transaction，available values: FAILED,COMPLETED,PENDING,INITIAL. | ||
| response.transaction_list.transaction_type | string | The type of transaction. | ||
| response.transaction_list.txn_title | string | The transaction title sent by client (Adjustment Center) for adjustments, Only for ID local sellers for now. | ||
| response.transaction_list.amount | float | The amount of transaction. | ||
| response.transaction_list.current_balance | float | The current balance of this account. | ||
| response.transaction_list.create_time | int | The create time of the transaction. | ||
| response.transaction_list.order_sn | string | Shopee's unique identifier for an order. | ||
| response.transaction_list.refund_sn | string | The serial number of return. | ||
| response.transaction_list.withdrawal_type | string | The type of withdrawal. | ||
| response.transaction_list.transaction_fee | float | This field indicates the transaction fee. | ||
| response.transaction_list.description | string | The detailed description of TOPUP SUCCESS and TOPUP FAILED. | ||
| response.transaction_list.buyer_name | string | The name of buyer. | ||
| response.transaction_list.pay_order_list | object[] | |||
| response.transaction_list.pay_order_list.order_sn | string | Shopee's unique identifier for an order. | ||
| response.transaction_list.pay_order_list.shop_name | string | Name of the shop. | ||
| response.transaction_list.shop_name | string | Name of the shop. | ||
| response.transaction_list.withdrawal_id | int | Withdrawal ID when transaction type is withdraw_created, withdrawal_completed, withdrawal_cancelled. | ||
| response.transaction_list.reason | string | The reason for ADJUSTMENT_ADD and ADJUSTMENT_MINUS. | ||
| response.transaction_list.root_withdrawal_id | int | Use this field to indicate the event where a withdrawal is split into several withdrawals due to the withdrawal limit. | ||
| response.transaction_list.transaction_tab_type | string | Description: A new response parameter added after: https://confluence.shopee.io/display/SPCT/%5BPRD%5D+%5BOpen+API%5D+Update+on+New+Open+API+to+fetch+Seller+wallet+Transaction This returns the updated transaction tab types that client can use to specify which transaction types they want to return. It will have the following tab types Default wallet_order_income wallet_adjustment_filter; wallet_wallet_payment; wallet_refund_from_order; wallet_withdrawals; fast_escrow_repayment; fast_pay; seller_loan corporate_loan pix_transactions_filter; open_finance_transactions_filter Note for BR, currently in SOP live configuration, wallet txn type that linked to pix_transactions_filter and open_finance_transactions_filter are classified as default type tab instead. therefore for Open API client who wants to query these 2 txn can put default as the filter in this type | ||
| response.transaction_list.money_flow | string | New response parameter provided after: https://confluence.shopee.io/display/SPCT/%5BPRD%5D+%5BOpen+API%5D+Update+on+New+Open+API+to+fetch+Seller+wallet+Transaction It's to indicate the money flow; MONEY_IN = addition MONEY_OUT = deduction; if not specified in request, will return both; Note special case for TW JKO Pay, we will ignore Money_flow | ||
| response.transaction_list.outlet_shop_name | string | The outlet shop name where this outlet transaction came from. (In the Original Instant Mart concept, outlet transactions are redirected to Mart.) | ||
| response.more | boolean | |||
| request_id | string | xduiwekui134 | ||
| message | string | |||
| error | string |
§5 Common parameters
Common parameters
| Name | Type | Required | 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 |
§6 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| error_param | request not from gateway | |
| error_server | The inner server err when send http request. | |
| time_period_too_large | The param error: time period too large. | |
| time_invalid | The param error: create_time_from bigger than create_time_to. | |
| time_invalid | The param error: time is invalid |
§7 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| error_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| api_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00) | |
| error_rate_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api. | |
| error_api_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§8 Update log
Update log
| Date | Change |
|---|---|
| 2026-05-29 | add txn_title, a new field implemented as current display is too generic "Adjustment by Shopee" |
| 2024-11-01 | Add transaction_tab_type and money_flow in Request Parameter |
| 2022-11-03 | add withdrawal id and root withdrawal id |
| 2022-09-26 | delete the shop_name / withdraw_id / root_withdrawal_id response parameter |
| 2022-06-24 | Optimize the create_time_from and create_time_to field "Required" information |