依識別碼取得付款匯出要求
取得現有佇列匯出要求的狀態。
REST 要求
GET https://api.partner.microsoft.com/v1.0/payouts/payments/{paymentsRequestId}
要求參數
| 名稱 | 位於 | 必要 | 類型 | 描述 |
|---|---|---|---|---|
| requestId | 查詢 | True | Guid | 匯出要求識別碼 |
要求標頭
| 名稱 | 必要 | 類型 | 描述 |
|---|---|---|---|
| 授權 | 是 | String | 授權持有人權杖。 |
| ms-correlationid | 否 | String | 內部要求追蹤器。 每個要求都會產生新的追蹤器 (GUID) 。 |
| ms-requestid | 否 | String | 要求等冪識別碼。 |
要求本文
N/A。
回應承載
| 名稱 | 描述 |
|---|---|
| 200 已接受 | 已接受要求。 |
根據要求，API 可以傳回標準 API 回應狀態中列出的其他標準狀態：
| 名稱 | 描述 |
|---|---|
| 400 不正確的要求 | 資料遺失或不正確。 |
| 401 未經授權 | 呼叫端不會經過驗證，而且必須先向合作夥伴 API 服務進行驗證，才能進行第一次呼叫。 |
| 403 禁止 | 呼叫端未獲授權提出要求。 |
| 500 內部伺服器錯誤 | API 或其其中一個相依性無法滿足要求。 請稍後再試一次。 |
| 404 找不到 | 輸入參數無法使用資源。 |
| 429 速率限制 | 相同類型的要求太多。 請稍後再試一次。 |
API 回應承載會傳回下列屬性：
| 名稱 | 選用 | 描述 |
|---|---|---|
| 值 | false | 如需可能的值和動作，請參閱下表。 |
可能的值和動作
| 值 | 用戶端動作 |
|---|---|
| requestId | 匯出要求的要求識別碼 |
| requestDateTime | 匯出要求的起始日期時間 |
| requestPath | 匯出要求的查詢路徑。 |
| requestQueryString | 做為匯出要求的一部分使用的篩選。 |
| blobLocation | 當匯出檔案就緒時，具有權杖的 Blob 資源 |
| 狀態 | 匯出作業狀態。 如需狀態，請參閱下列可能值清單。 |
狀態的可能值
- 已排入佇列：匯出作業尚未啟動
- 處理：匯出作業正在進行中
- 失敗：重試之後匯出作業失敗，請嘗試將新要求排入佇列
- 已完成：匯出作業已完成，且匯出檔案已可供下載。