Servis Adresi
POST /Dealer/GetStatementList
İ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) |
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. |
|
| PaymentList 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 |
| TrxStatus string | İşlem durumu |
| Software string | Ödemenin gönderildiği platform |
|
| PaymentTrxList array |
| DealerPaymentTrxId integer | Ödeme hareketi id |
| DealerPaymentId integer | Ödeme 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 string | Sanal pos işlem numarası |
| ResultMessage string | Bankadan dönen hata mesajı |
|
Örnek İstek (JSON)
{
"DealerAuthentication":{
"DealerCode":"XXX",
"Username":"XXX",
"Password":"XXX",
"CheckKey":"28ba1f316e661ee7a0477a13aa30613da548c94a8098829af9255b04d7e916e3"
},
"DealerStatementRequest":{
"StatementStartDate":"",
"StatementEndDate":"",
"AccountingId":"",
"StatementId":"731"
}
}
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":731,
"CurrencyId":0,
"StatementStartDate":"2020-04-05T00:00:00",
"StatementEndDate":"2020-04-06T00:00:00",
"WillBePaidOn":"2020-04-07T00:00:00",
"StatementStatus":3,
"SalesCount":3,
"SalesTotal":300.00,
"SalesCommissionTotal":17.10,
"RefundCount":0,
"RefundTotal":0.00,
"RefundCommissionTotal":0.00,
"DealerAccountingId":0,
"Status":0,
"PaymentList":[
{
"DealerPaymentId":56125,
"OtherTrxCode":"20200406105805",
"CardHolderFullName":"Zeynep HASHAN",
"CardNumberFirstSix":"526955",
"CardNumberLastFour":"4444",
"PaymentDate":"2020-04-06T10:58:05.417",
"Amount":100.00,
"RefAmount":0.00,
"CurrencyCode":"TL",
"InstallmentNumber":2,
"DealerCommissionAmount":5.70,
"IsThreeD":false,
"Description":"",
"PaymentStatus":2,
"TrxStatus":1,
"Software":"Possimulation",
"PaymentTrxList":[
{
"DealerPaymentTrxId":37247,
"DealerPaymentId":56125,
"TrxCode":"25f0192d-d6f2-4230-bf42-851ca0163646",
"TrxDate":"2020-04-06T10:58:05.513",
"Amount":100.00,
"TrxType":2,
"TrxStatus":1,
"PaymentReason":1,
"VoidRefundReason":0,
"VirtualPosOrderId":"Test-169bb9bf-9d70-4008-a35c-81e59cd2a018",
"ResultMessage":""
}
]
},
{
"DealerPaymentId":56126,
"OtherTrxCode":"20200406105808",
"CardHolderFullName":"Zeynep HASHAN ",
"CardNumberFirstSix":"526955",
"CardNumberLastFour":"4444",
"PaymentDate":"2020-04-06T10:58:08.26",
"Amount":100.00,
"RefAmount":0.00,
"CurrencyCode":"TL",
"InstallmentNumber":2,
"DealerCommissionAmount":5.70,
"IsThreeD":false,
"Description":"",
"PaymentStatus":2,
"TrxStatus":1,
"Software":"Possimulation",
"PaymentTrxList":[
{
"DealerPaymentTrxId":37248,
"DealerPaymentId":56126,
"TrxCode":"8a092cca-40c8-4393-bd70-49b64166b2e3",
"TrxDate":"2020-04-06T10:58:08.29",
"Amount":100.00,
"TrxType":2,
"TrxStatus":1,
"PaymentReason":1,
"VoidRefundReason":0,
"VirtualPosOrderId":"Test-03f20fef-63d4-4ca8-93c6-0b3c2ba331b3",
"ResultMessage":""
}
]
},
{
"DealerPaymentId":56127,
"OtherTrxCode":"20200406105812",
"CardHolderFullName":"Zeynep HASHAN ",
"CardNumberFirstSix":"526955",
"CardNumberLastFour":"4444",
"PaymentDate":"2020-04-06T10:58:12.213",
"Amount":100.00,
"RefAmount":0.00,
"CurrencyCode":"TL",
"InstallmentNumber":2,
"DealerCommissionAmount":5.70,
"IsThreeD":false,
"Description":"",
"PaymentStatus":2,
"TrxStatus":1,
"Software":"Possimulation",
"PaymentTrxList":[
{
"DealerPaymentTrxId":37249,
"DealerPaymentId":56127,
"TrxCode":"70d8e65c-adc8-4aef-9953-d8e9c195618e",
"TrxDate":"2020-04-06T10:58:12.23",
"Amount":100.00,
"TrxType":2,
"TrxStatus":1,
"PaymentReason":1,
"VoidRefundReason":0,
"VirtualPosOrderId":"Test-2bc95853-ba6d-44f6-875e-d7946fd27c70",
"ResultMessage":""
}
]
}
]
}
]
},
"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.GetStatementList.InvalidRequest | CheckKey hatalı ya da nesne hatalı ya da JSON bozuk olabilir. |
| Dealer.GetStatementList.InvalidDateFormat | Tarih biçimi geçersiz |
| Dealer.GetStatementList.StatementNotFound | Ekstre bulunamadı. |
| Dealer.GetStatementList.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.GetStatementList.InvalidStatementIdOrAccountingId",
"ResultMessage":"",
"Exception":null
}