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
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/payment/get_billing_transaction_info
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo từ partner_id, đường dẫn api, timestamp, access_token, shop_id và partner_key qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| 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 |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Error code | |
| message | string | Error message | |
| request_id | string | 10fff653c945a390f8e1323c6bdffff4 | Mã định danh của yêu cầu API dùng để theo dõi lỗi. |
| 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 |