v2.payment.get_billing_transaction_info
POST /api/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
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/payment/get_billing_transaction_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 |
|---|---|---|---|---|
| billing_transaction_info_type | int | True | 1 | Billing transaction types: 1: TO_RELEASE, 2: RELEASED |
| encrypted_payout_ids | string[] | False | ["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 | 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. |
| page_size | int | True | 100 | Number of pages returned max:100 |
Response Parameters
| Name | Type | 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 | ||
| transactions | object | ||
| amount | float | -594.78 | each transaction's amount |
| currency | string | SGD | transaction currency |
| order_sn | string | SGD | transaction currency |
| cost_header | string | Refund Amount | transaction belongs to which type |
| scenario | string | Return Refund After Order Completed | transaction detailed scenarios |
| remark | string | Deduction on return refund requests raised after order is completed | detailed description for this transactions |
| level | string | Order | To define this transaction happen at order level or shop level. e.g. shop level adjustment |
| billing_transaction_type | string | ADJUSTMENT | could be Escrow (Order Income) or Adjustment (for this order) |
| billing_transaction_status | string | Released | Will be either "To Release" or "Released". |
| more | boolean | false | |
| next_cursor | string | false |