Ödeme dışarı aktarma isteği oluşturma

Ödemeler için yeni bir dışarı aktarma isteği kuyruğa almak için API uç noktasına bir POST isteği gönderin.

REST isteği

Yöntem	İstek URI'si
post	https://api.partner.microsoft.com/v1.0/payouts/payments?$filter={$filter}&fileformat=csv

İstek parametreleri

İsim	İçinde	Gerekli	Tür	Açıklama
$filtre	Sorgu	Hayır	Dizgi	İsteğe bağlı bir filtre olsa da, son üç yıllık verileri dışarı aktarmak yerine daha hızlı performans için filtreleri kullanmanızı ve dışarı aktarma verilerinizi sınırlamanızı kesinlikle öneririz. Tüm $filter seçenekleri için aşağıdaki tabloya bakın.
dosyaBiçimi	Sorgu	Hayır	Dize	Desteklenen değerler .csv/.tsv. Hiçbir değer sağlanmazsa varsayılan olarak .csv olur.

İsim	Açıklama	Tür	Biçim
programName	Kayıtlı olduğunuz bir veya daha fazla program tarafından filtreleyin. Örnek değerler - 'CSP Dolaylı Sağlayıcı', 'CSP 2T Dolaylı Sağlayıcı', 'CSP Direkt Fatura İş Ortağı', 'CSP 1T Direkt İş Ortağı', 'CSP Dolaylı Bayi', 'CSP 2T Dolaylı Bayi'	Dizgi	{baseUrl}/v1.0/payouts/payments?$filter=?$filter=programName=’CSP Indirect Provider’

Birden çok istek parametresiyle örnek ödemeler filtresi

“?$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')”

İstek üst bilgisi

İsim	Gerekli	Tür	Açıklama
İzin	Evet	Dizgi	Yetkilendirme Taşıyıcı Belirteç.
ms-correlationid	Hayır	Dizgi	Dahili talep izleyicisi. Her istek yeni bir izleyici (GUID) oluşturur.
ms-requestid	Hayır	Dize	İstek eşzamanlılık kimliği.

Daha fazla bilgi için bkz. İş Ortağı Merkezi REST başlıkları.

İstek gövdesi

Geçerli Değil

API yanıtı

HTTP/1.1 202 Accepted

API yanıt yükü aşağıdaki öznitelikleri döndürür:

İsim	Opsiyonel	Açıklama
Değer	yanlış	Olası değerler ve eylemler için aşağıdaki tabloya bakın.

Değer	Müşteri eylemi
requestId	Dışarı aktarma talebinin istek kimliği
Talep Tarih ve Saat	Dışarı aktarma isteğinin başlatma tarih saati
requestPath	Dışa aktarma isteğinin sorgu yolu.
requestQueryString	Dışarı aktarma isteğinin bir parçası olarak kullanılan filtre.
blobLocation	Blob kaynağı, dışa aktarma dosyası hazır olduğunda bir token içerecektir.
Durum	dışarı aktarma işlemi durumu. Durum için olası değerlerin aşağıdaki listesine bakın.

Durum için olası değerler

• Kuyruğa Alınmış: Dışa aktarma işlemi başlatılmadı
• İşleme: Dışarı aktarma işlemi devam ediyor
• Başarısız: Dışarı aktarma işlemi yeniden denemeden sonra başarısız oldu, yeni bir isteği kuyruğa almayı deneyin
• Tamamlandı: Dışarı aktarma işlemi tamamlandı ve dışarı aktarma dosyası indirilme için hazır.

Örnek yanıt:

{
    "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 durumu 202'i döndürür.

İsim	Açıklama
202 Kabul Edildi	İstek kabul edilir. İstek durumu için GET isteği URL'sini sorgula.

İsteğe bağlı olarak, API diğer standart durumları döndürebilir:

İsim	Açıklama
400 Hatalı İstek	Eksik veya yanlış veriler vardı.
401 Yetkisiz	Arayan kimliği doğrulanmamıştır ve ilk çağrıyı yapmadan önce iş ortağı API hizmetiyle kimlik doğrulaması yapmalıdır.
403 Yasak	Arayan, isteği yapma yetkisine sahip değil.
500 İç Sunucu Hatası	API veya bağımlılıklarından biri isteği karşılayamıyor. Daha sonra yeniden deneyin.
404 Bulunamadı	Kaynak giriş parametreleriyle kullanılamaz.
429 Hız sınırlama	Aynı türde çok fazla istek var. Bir süre sonra deneyin.