Pazar Yeri - Bayi Ekstresini Görme
Servis Adresi
POST /Dealer/GetStatementListMarketPlace
İstek Parametreleri
PaymentDealerAuthentication
| Parametre |
Açıklama |
| DealerCode string |
Ruut sistemi tarafından verilen bayi kodu |
| Username string |
Ruut sistemi tarafından verilen Api kullanıcı adı |
| Password string |
Ruut sistemi tarafından verilen Api şifresi |
| CheckKey string |
Kontrol anahtarı (DealerCode + "MK" + Username + "PD" + Password) String olarak birleştirilen bu bilgilerin SHA-256 hash algoritmasından geçirilmesiyle oluşturulur.
Buraya tıklayarak deneme ekranına gidebilirsiniz. |
DealerStatementRequest
| Parametre |
Açıklama |
| StatementStartDate datetime |
Ekstrenin başlangıç tarihi (yyyy-MM-dd ) (opsiyonel) |
| StatementEndDate datetime |
Ekstrenin bitiş tarihi (yyyy-MM-dd ) (opsiyonel) |
| AccountingId integer |
İlgili işleme ait muhasebe id. (opsiyonel) |
| StatementId integer |
Ekstre id. (opsiyonel) |
| SubDealerId integer |
Alt bayi id, (zorunlu) |
Returns
| Parametre |
Açıklama |
| StatementList array |
| DealerStatementId integer | Bayi ekstre id. |
| CurrencyId integer | Para birimi id. |
| StatementStartDate datetime | Ekstre başlangıç tarihi. |
| StatementEndDate datetime | Ekstre bitiş tarihi. |
| WillBePaidOn datetime | Ödemenin bayiye ne zaman yatırılacağı bilgisi. |
| StatementStatus integer | Ekstrenin durumu. |
| SalesCount integer | Satışların sayısı. |
| SalesTotal decimal | Satışların toplamı. |
| SalesCommissionTotal decimal | Satışların komisyon toplamı. |
| RefundCount integer | İade sayısı. |
| RefundTotal decimal | İadelerin toplamı. |
| RefundCommissionTotal decimal | İade komisyonlarının toplamı. |
| DealerAccountingId integer | Bayi muhasebe id. |
| Status integer | Durum. |
|
| PaymentTrxList array |
| DealerPaymentId integer | Ödeme id |
| OtherTrxCode string | Karşı işlem numarası |
| CardHolderFullName string | Kart sahibinin adi ve soyadı |
| CardNumberFirstSix string | Kart numarasının ilk 6 hanesi |
| CardNumberLastFour string | Kart numarasının son 4 hanesi |
| PaymentDate datetime | Ödeme tarihi |
| Amount decimal | Ödeme tutarı |
| RefAmount decimal | İade tutarı |
| CurrencyCode string | Para birimi |
| InstallmentNumber integer | Taksit sayısı |
| DealerCommissionAmount decimal | Bayi komisyon tutarı |
| IsThreeD bool | 3D Ödeme mi? |
| Description string | Ödeme açıklaması |
| PaymentStatus string | Ödeme durumu (ön provizyon, ödeme, iptal, iade vb.) |
| TrxStatus string | İşlem durumu (bekliyor, başarılı, basarisiz vb.) |
| Software string | Ödemenin gönderildiği platform |
|
| SubPaymentList array |
| DealerPaymentDealerId integer | Alt ödeme liste id. |
| DealerId integer | Üye iş yeri id. |
| Amount decimal | Alt üye iş yeri ödeme tutarı. |
| RefAmount decimal | Alt üye iş yeri iade tutarı. |
| DealerCommissionAmount decimal | Üye iş yeri komisyon tutarı |
| DealerGroupCommissionAmount decimal | Üst üye iş yeri komisyon tutarı |
|
| PaymentTrxDetailList array |
| DealerPaymentTrxId integer | Ödeme hareketi id. |
| TrxCode string | Banka ile Ruut arasındaki işlem kodu. |
| TrxDate datetime | İşlem tarihi. |
| Amount decimal | Ödeme tutarı. |
| TrxType integer | Ödeme işleminin tipi. |
| TrxStatus integer | Ödeme işleminin durumu. |
| PaymentReason integer | Ödeme durumu (iptal, iade, normal ödeme, vb.) |
| VoidRefundReason integer | İptal veya iadenin sebebini gösteren kod. |
| VirtualPosOrderId integer | Sanal pos işlem numarası. |
| ResultMessage string | Bankadan dönen hata mesajı. |
|
| SubPaymentTrxList array |
| DealerPaymentTrxDealerId integer | Alt ödeme hareketi id. |
| DealerPaymentDealerId integer | Alt ödeme liste id. |
| DealerId integer | Üye iş yeri id. |
| Amount decimal | Ödeme tutarı. |
| DealerCommissionAmount decimal | Üye iş yeri komisyon tutarı |
| DealerGroupCommissionAmount decimal | Üst üye iş yeri komisyon tutarı |
|
Örnek İstek (JSON)
{
"DealerAuthentication":{
"DealerCode":"XXXX",
"Username":"XXXX",
"Password":"XXXXX",
"CheckKey":"28ba1f316e661ee7a0477a13aa30613da548c94a8098829af9255b04d7e916e3"
},
"DealerStatementRequest":{
"StatementStartDate":"2020-04-01",
"StatementEndDate":"2020-05-05",
"AccountingId":"",
"StatementId":"735",
"SubDealerId":"12345"
}
}
Başarılı İstek Sonucu
Gönderilen istek verileri Ruut’ da başarılı bir şekilde işlenmişse, geri dönüş nesnesinin
"ResultCode" alanında "Success" bilgisi yazar. "Data" alanında ise bankadan dönen işlem
sonucu bulunur. "Data" içinde yer alan "IsSuccessful" (true/false) alanı kontrol edilerek
işlemin durumu kontrol edilir. Bu alanda false dönmesi durumunda aynı nesne içindeki
ResultCode ve ResultMessage alanları kontrol edilerek işlemin sanal pos üzerinde neden
başarısız olduğu görülebilir.
Başarılı Sonuç Örneği
{
"Data":{
"IsSuccessful":true,
"ResultCode":"",
"ResultMessage":"",
"ListItemCount":1,
"StatementList":[
{
"DealerStatementId":735,
"CurrencyId":0,
"StatementStartDate":"2020-04-10T00:00:00",
"StatementEndDate":"2020-04-11T00:00:00",
"WillBePaidOn":"2020-04-17T00:00:00",
"StatementStatus":3,
"SalesCount":2,
"SalesTotal":100.00,
"SalesCommissionTotal":4.00,
"RefundCount":0,
"RefundTotal":0.00,
"RefundCommissionTotal":0.00,
"DealerAccountingId":0,
"Status":0,
"PaymentTrxList":[
{
"PaymentDetail":{
"DealerPaymentId":56484,
"OtherTrxCode":"20200411153306",
"CardHolderFullName":"Zeynep HASHAN",
"CardNumberFirstSix":"526955",
"CardNumberLastFour":"4444",
"PaymentDate":"2020-04-11T15:33:06.557",
"Amount":100.00,
"RefAmount":0.00,
"CurrencyCode":"TL",
"InstallmentNumber":0,
"DealerCommissionAmount":3.50,
"DealerGroupCommissionAmount":2.00,
"IsThreeD":false,
"Description":"",
"PaymentStatus":2,
"TrxStatus":1,
"Software":"Possimulation",
"SubPaymentList":[
{
"DealerPaymentDealerId":30228,
"DealerId":167,
"Amount":50.00,
"RefAmount":0.00,
"DealerCommissionAmount":2.00,
"DealerGroupCommissionAmount":1.00
}
]
},
"PaymentTrxDetailList":[
{
"DealerPaymentTrxId":37622,
"TrxCode":"c067dec9-953c-4cb3-ac9f-aba91dab9a67",
"TrxDate":"2020-04-11T15:33:06.613",
"Amount":100.00,
"TrxType":2,
"TrxStatus":1,
"PaymentReason":1,
"VoidRefundReason":0,
"VirtualPosOrderId":"Test-8e6dae7f-7eac-4b13-a619-d879a0a005b8",
"ResultMessage":"",
"SubPaymentTrxList":[
{
"DealerPaymentTrxDealerId":37134,
"DealerPaymentDealerId":30228,
"DealerId":167,
"Amount":50.00,
"DealerCommissionAmount":2.00,
"DealerGroupCommissionAmount":1.00
}
]
}
]
},
{
"PaymentDetail":{
"DealerPaymentId":56485,
"OtherTrxCode":"20200411153308",
"CardHolderFullName":"Zeynep HASHAN",
"CardNumberFirstSix":"526955",
"CardNumberLastFour":"4444",
"PaymentDate":"2020-04-11T15:33:09.117",
"Amount":100.00,
"RefAmount":0.00,
"CurrencyCode":"TL",
"InstallmentNumber":0,
"DealerCommissionAmount":3.50,
"DealerGroupCommissionAmount":2.00,
"IsThreeD":false,
"Description":"",
"PaymentStatus":2,
"TrxStatus":1,
"Software":"Possimulation",
"SubPaymentList":[
{
"DealerPaymentDealerId":30230,
"DealerId":167,
"Amount":50.00,
"RefAmount":0.00,
"DealerCommissionAmount":2.00,
"DealerGroupCommissionAmount":1.00
}
]
},
"PaymentTrxDetailList":[
{
"DealerPaymentTrxId":37623,
"TrxCode":"3ba04827-66fb-45f0-b720-fbeb77340c09",
"TrxDate":"2020-04-11T15:33:09.13",
"Amount":100.00,
"TrxType":2,
"TrxStatus":1,
"PaymentReason":1,
"VoidRefundReason":0,
"VirtualPosOrderId":"Test-dbe8cc01-904a-43e2-8a32a2b1f5feed5e",
"ResultMessage":"",
"SubPaymentTrxList":[
{
"DealerPaymentTrxDealerId":37136,
"DealerPaymentDealerId":30230,
"DealerId":167,
"Amount":50.00,
"DealerCommissionAmount":2.00,
"DealerGroupCommissionAmount":1.00
}
]
}
]
}
]
}
]
},
"ResultCode":"Success",
"ResultMessage":"",
"Exception":null
}
Başarısız İstek Sonucu
Gönderilen istek verileri Ruut akışları içerisinde işlenemediyse, geri dönüş nesnesinin ResultCode alanında alttaki tablodaki hata kodlarından birisi bulunur.
Beklenmeyen yazılımsal bir hata oluştuğunda ise, ResultCode alanında EX yazar ve ResultMessage alanında alınan hata mesajı (Exception) yer alır.
Her iki durumda da, Data nesnesi null olarak gelir.
| ResultCode | Açıklama |
| Dealer.CheckDealerAuthentication.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
| Dealer.CheckDealerAuthentication.InvalidAccount | Böyle bir bayi bulunamadı. |
| Dealer.GetStatementListMarketPlace.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
| PaymentDealer.GetStatementListMarketPlace.DealerNotAuthorized | Bu bayinin yetkisi yok. |
| Dealer.GetStatementListMarketPlace.SubDealerIdRequired | Alt bayi id geçersiz. |
| Dealer.GetStatementListMarketPlace.SubDealerNotFound | Alt bayi bulunamadı. |
| Dealer.GetStatementListMarketPlace.InvalidDateFormat | Tarih biçimi geçersiz. |
| Dealer.GetStatementListMarketPlace.StatementNotFound | Ekstre bulunamadı. |
| Dealer.GetStatementListMarketPlace.InvalidStatementIdOrAccountingId | Ekstre id veya muhasebe id geçersiz. |
| EX | Beklenmeyen bir hata oluştu |
Başarısız Sonuç Örneği
{
"Data":null,
"ResultCode":" Dealer.GetStatementListMarketPlace.SubDealerIdRequired",
"ResultMessage":"",
"Exception":null
}