stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.payment.get_billing_transaction_info
This API is applicable for Cross Border (CB) sellers only to get the detailed payout transaction data, both released and to-be released transaction can be found in here
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Payment |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/payment/get_billing_transaction_info |
| Production URL | https://partner.shopeemobile.com/api/v2/payment/get_billing_transaction_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/payment/get_billing_transaction_info |
| Permission | ERP System; Seller In House System; Accounting And Finance; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| billing_transaction_info_type | int | Yes | 1 | Billing transaction types: 1: TO_RELEASE, 2: RELEASED |
| encrypted_payout_ids | string[] | No | ["10376329180766","637926329180767"] | encrypted_payout_id get from API: v2.get_payout_info; when encrypted_payout_id provided and billing_transaction_info_type=2, we will return the "released" billing items under this payout.; when encrypted_payout_id not provided, we will return the "to release" billing items under hasn't form payout yet; Max length: 100 |
| cursor | string | Yes | "" | 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. |
| page_size | int | Yes | 100 | Number of pages returned max:100 |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Error code | ||
| message | string | Error message | ||
| request_id | string | 10fff653c945a390f8e1323c6bdffff4 | The identifier for an API request for error tracking. | |
| response | object | |||
| response.transactions | object | |||
| response.transactions.amount | float | -594.78 | each transaction's amount | |
| response.transactions.currency | string | SGD | transaction currency | |
| response.transactions.order_sn | string | SGD | transaction currency | |
| response.transactions.cost_header | string | Refund Amount | transaction belongs to which type | |
| response.transactions.scenario | string | Return Refund After Order Completed | transaction detailed scenarios | |
| response.transactions.remark | string | Deduction on return refund requests raised after order is completed | detailed description for this transactions | |
| response.transactions.level | string | Order | To define this transaction happen at order level or shop level. e.g. shop level adjustment | |
| response.transactions.billing_transaction_type | string | ADJUSTMENT | could be Escrow (Order Income) or Adjustment (for this order) | |
| response.transactions.billing_transaction_status | string | Released | Will be either "To Release" or "Released". | |
| response.more | boolean | false | ||
| response.next_cursor | string | false |
§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 Request samples
Request samples
§7 Payload
Payload
{
"billing_transaction_info_type": 1,
"encrypted_payout_ids": [
"10376329180766",
"637926329180767"
],
"cursor": "\"\"",
"page_size": 100
}
§8 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://open.admin.uat.shopee.io/api/v2/payment/get_billing_transaction_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
\"billing_transaction_info_type\": 1,
\"cursor\": \"\\"\\"\",
\"encrypted_payout_ids\": [
\"10376329180766\",
\"637926329180767\"
],
\"page_size\": 100
}")
.asString();
§9 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://open.admin.uat.shopee.io/api/v2/payment/get_billing_transaction_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"billing_transaction_info_type": 1,
"cursor": "\\"\\"",
"encrypted_payout_ids": [
"10376329180766",
"637926329180767"
],
"page_size": 100
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§10 cURL
cURL
curl --location --request POST 'https://open.admin.uat.shopee.io/api/v2/payment/get_billing_transaction_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
"billing_transaction_info_type": 1,
"cursor": "\"\"",
"encrypted_payout_ids": [
"10376329180766",
"637926329180767"
],
"page_size": 100
}'
§11 Python
Python
import requests
import json
url = "https://open.admin.uat.shopee.io/api/v2/payment/get_billing_transaction_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload=json.dumps({
"billing_transaction_info_type": 1,
"cursor": "\"\"",
"encrypted_payout_ids": [
"10376329180766",
"637926329180767"
],
"page_size": 100
})
headers = {
'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§12 Response sample
Response sample
§13 JSON
JSON
{
"response": {
"transactions": [
{
"amount": -594.78,
"currency": "SGD",
"order_sn": "230712RFB30UES",
"cost_header": "Refund Amount",
"scenario": "Return Refund After Order Completed",
"remark": "Deduction on return refund requests raised after order is completed",
"level": "ORDER",
"billing_transaction_type": "ADJUSTMENT",
"billing_transaction_status": "RELEASED"
}
],
"more": false,
"next_cursor": ""
},
"error": "",
"message": "",
"request_id": "dec735be0923db4f300912f713010900"
}
§14 Error example
Error example
§15 JSON
JSON
{
"error": "error_param",
"message": "shop_id is required",
"request_id": "542a76d70923dd7d25f92936088b2800"
}
§16 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_param | cursor is required and format should be correct. Please check | |
| common.error_not_found | Unknown error: ***. Something wrong. Please try later. | |
| error_param | billing_transaction_info_type provided is invalid, please use one of the support billing item type values: 1 - To Release, 2 - Released. | |
| error_param | page_size is required, format should be correct and input within 1-100 | |
| error_param | payout ids{id1,id2,...} not found, please recheck if the id is correct or not | |
| error_param | payout ids can not be empty when querying Released info | |
| error_param | payout ids length exceed limit | |
| error_param | shop_id is required | |
| error_param | billing_transaction_info_type is required | |
| 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_param | Invalid or missing cursor parameter. Please enter an empty string i.e. "" for the first request or use the next_cursor value returned from the previous response for subsequent requests. | |
| error_server | Internal server error | |
| error_param | The request body is not a valid json format | |
| error_param | This payment API is only applicable for cross boarder shop | |
| error_param | Invalid or missing page_size parameter , please enter a valid value that is with 1-100, indicating the number of records within a page. |
§17 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. |
§18 Update log
Update log
| Date | Change |
|---|---|
| 2024-01-02 | New API |
