建立付款匯出要求

將 POST 要求提交至 API 端點，以將新的匯出要求排入佇列以進行付款。

REST 要求

方法	要求 URI
POST	https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

要求參數

名稱	位於	必要	類型​	描述
$filter	查詢	No	String	雖然它是選擇性篩選，但我們強烈建議使用篩選來加快效能，並限制匯出資料，而不是匯出過去三年的資料。 如需一組完整的$filter選項，請參閱下表。
fileFormat	查詢	No	String	支援的值為 .csv/.tsv。 如果未提供任何值，則預設為 .csv。

名稱	描述	類型	格式
programName	依您註冊的一或多個程式進行篩選。 範例值 - 'CSP 間接提供者'、'CSP 2T 間接提供者'、'CSP Direct Bill Partner'、'CSP 1T Direct Partner'、'CSP 間接轉銷商'、'CSP 2T 間接轉銷商'	String	{baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

具有多個要求參數的範例付款篩選

“?$filter=payoutStatusUpdateTS le 2019-09-25T23:11:55.647Z and (enrollmentParticipantId eq 'XXXXXXX') and (programName eq 'CSP Direct Bill Partner') and (payoutOrderType eq 'REBATE') and (paymentId eq '000000000000')”

要求標頭

名稱	必要	類型​	描述
授權	Yes	String	授權持有人權杖。
ms-correlationid	No	String	內部要求追蹤器。 每個要求都會產生新的追蹤器 （GUID）。
ms-requestid	No	String	要求等冪識別碼。

若要深入瞭解，請參閱 合作夥伴中心 REST 標頭 。

要求本文

N/A

API 回應

HTTP/1.1 202 Accepted

API 回應承載會傳回下列屬性：

名稱	選擇性	描述
值	false	如需可能的值和動作，請參閱下表。

值	用戶端動作
requestId	匯出要求的要求識別碼
requestDateTime	匯出要求的起始日期時間
requestPath	匯出要求的查詢路徑。
requestQueryString	做為匯出要求的一部分使用的篩選。
blobLocation	匯出檔案就緒時具有權杖的 Blob 資源
狀態	匯出作業狀態。 如需狀態，請參閱下列可能值的清單。

狀態的可能值

• 已排入佇列：匯出作業尚未啟動
• 處理 ：匯出作業正在進行中
• 失敗 ：重試之後匯出作業失敗，請嘗試將新要求排入佇列
• 已完成 ：匯出作業已完成，且匯出檔案已準備好下載。

回應範例：

{
    "value": [
        {
            "requestId": "93c2b3cf-c6d8-4e7e-ade1-007768a6eba4",
            "requestDateTime": "2023-05-25T21:20:46.3727561Z",
            "requestPath": "/v1.0/payouts/payments",
            "requestQueryString": "paymentDate ge 2023-03-01 and paymentDate le 2023-04-12",
            "blobLocation": "",
            "status": "Queued"
        }
    ],
    "nextLink": null,
    "totalCount": 1
}

API 會傳回 HTTP 狀態 202。

名稱	描述
202 已接受	已接受要求。 查詢要求狀態的 GET 要求 URL。

根據要求，API 可以傳回其他標準狀態：

名稱	描述
400 不正確的要求	資料遺失或不正確。
401 未經授權	呼叫端未通過驗證，且必須先向合作夥伴 API 服務進行驗證，才能進行第一次呼叫。
403 禁止	呼叫端無權提出要求。
500 內部伺服器錯誤	API 或其其中一個相依性無法滿足要求。 請稍後再試一次。
404 找不到	輸入參數無法使用資源。
429 速率限制	相同類型的要求太多。 請稍後再試一次。