共用方式為

建立付款匯出要求

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

REST 要求

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

要求參數

名字 在 必填 類型 描述
$過濾器 查詢 不 字串 雖然它是選擇性篩選，但我們強烈建議使用篩選來加快效能，並限制匯出數據，而不是導出過去三年的數據。 如需一組完整的$filter選項，請參閱下表。
檔案格式 查詢 不 字串 支援的值為 .csv/.tsv。 如果未提供任何值，則預設為 .csv。
名字 描述 類型 格式
programName 依您註冊的一或多個程序進行篩選。 範例值 - 'CSP 間接提供者'、'CSP 2T 間接提供者'、'CSP 直接帳單夥伴'、'CSP 1T 直接夥伴'、'CSP 間接轉銷商'、'CSP 2T 間接轉銷商' 字串 {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')”

請求標頭

名字 必填 類型 描述
授權 是的 字串 授權持有人令牌。
ms-correlationid 不 字串 內部請求追蹤器。 每個要求都會產生新的追蹤器 （GUID）。
ms-requestid 不 字串 要求等冪標識碼。

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

請求主體

N/A

API 回應

HTTP/1.1 202 Accepted

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

名字 可選的 描述
價值 假 如需可能的值和動作，請參閱下表。
價值 用戶端動作
請求編號 匯出要求的要求標識碼
請求日期時間 匯出要求的起始日期時間
請求路徑 匯出要求的查詢路徑。
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 速率限制 相同類型的要求太多。 請稍後再試一次。
  • Last updated on