Ödeme dışarı aktarma isteği oluşturma
Ödemeler için yeni bir dışarı aktarma isteğini kuyruğa almak için API uç noktasına bir POST isteği gönderin.
REST isteği
Yöntem | İstek URI'si |
---|---|
POST | {baseURL}/v{version}/payouts/payments?$filter={$filter}&fileformat=csv |
İstek parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
$filter | Sorgu | Hayır | Dize | İ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. |
Fileformat | Sorgu | Hayır | Dize | Desteklenen değerler /.tsv .csv. Değer sağlanmazsa varsayılan olarak .csv. |
Adı | 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 Doğrudan Fatura İş Ortağı', 'CSP 1T Doğrudan İş Ortağı', 'CSP Dolaylı Kurumsal Bayi', 'CSP 2T Dolaylı Kurumsal Bayi' | Dize | {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
Name | Gerekli | Tür | Description |
---|---|---|---|
Yetkilendirme | Evet | Dize | Yetkilendirme Taşıyıcı Belirteci. |
ms-correlationid | Hayır | Dize | bir iç istek izleyicisi. Her istek yeni bir izleyici (GUID) oluşturur. |
ms-requestid | Hayır | Dize | İstek bir kez etkililik kimliği. |
Daha fazla bilgi edinmek için bkz. İş Ortağı Merkezi REST üst bilgileri.
İstek gövdesi
Yok
API yanıtı
HTTP/1.1 202 Accepted
API yanıt yükü aşağıdaki öznitelikleri döndürür:
Name | İsteğe Bağlı | Description |
---|---|---|
Değer | yanlış | Olası değerler ve eylemler için aşağıdaki tabloya bakın. |
Değer | İstemci eylemi |
---|---|
requestId | Dışarı aktarma isteğinin istek kimliği |
requestDateTime | Dışarı aktarma isteğinin başlatma tarih saati |
requestPath | Dışarı aktarma isteğinin sorgu yolu. |
requestQueryString | Dışarı aktarma isteğinin bir parçası olarak kullanılan filtre. |
blobLocation | Dışarı aktarma dosyası hazır olduğunda belirteci olan blob kaynağı |
Durum | dışarı aktarma işlemi durumu. Durum için aşağıdaki olası değerler listesine bakın. |
Durum için olası değerler
- Kuyruğa alındı: Dışarı aktarma işlemi başlatılmadı
- İşleme: Dışarı aktarma işlemi devam ediyor
- Başarısız: Dışarı aktarma işlemi yeniden denendikten sonra başarısız oldu, yeni bir isteği kuyruğa eklemeyi deneyin
- Tamamlandı: Dışarı aktarma işlemi tamamlandı ve dışarı aktarma dosyası indirmeye 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.
Adı | Açıklama |
---|---|
202 Kabul Edildi | İstek kabul edildi. İstek durumu için GET isteği URL'sini sorgula. |
İsteğe bağlı olarak, API diğer standart durumları döndürebilir:
Adı | 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ı yapması gerekir. |
403 Yasak | Çağıranın isteği yapma yetkisi yok. |
500 İç Sunucu Hatası | API veya bağımlılıklarından biri isteği karşılayamıyor. Daha sonra tekrar deneyin. |
404 Bulunamadı | Giriş parametreleriyle kaynak kullanılamıyor. |
429 Hız sınırlama | Aynı türde çok fazla istek var. Bir süre sonra deneyin. |