HGS Geçiş Sorgula

Bu API müşterinin yetkili olduğu ürünün geçiş bilgilerini getirmektedir. Sorgu sonucunda sayfa başına maksimum 1000 kayıt gelmektedir. Başlangıç ve bitiş tarih aralığı maksimum 1 yıl olmalıdır.

API Bilgileri

URL

 /FPSInquirePass

Metot

 POST

Versiyon

 1.0

Scope

 payment

Yetkilendirme Yöntemi

 Authorization Code
B2B Credentials


Girdi Bilgileri

Alan Adı Format Açıklama Zorunlu/Opsiyonel

ProductNumber

 String Ürün numarası Zorunlu

StartDate

 yyyy-MM-dd Başlangıç tarihi Zorunlu

EndDate

 yyyy-MM-dd Bitiş tarihi Zorunlu

PageNumber

 Integer Sayfa numarası
Her bir sayfa maksimum 1000 kayıt içerecektir. Varsayılan değer 0’dır. 		Opsiyonel


Çıktı Bilgileri

List< PassInfo >

Alan Adı Format Açıklama

ProductNumber

 Integer Ürün numarası

NumberPlate

 String Plaka numarası

VehicleGrade

 Integer Araç sınıfı

EntryStation

 String Giriş istasyonu

ExitStation

 String Çıkış istasyonu

ExitDate

 yyyy-MM-ddTHH24:mm:ss Çıkış tarihi

BusinessName

 String İşletme adı

TransactionType

 String İşlem tipi

PassFee

 Decimal Geçiş bedeli

PaymentDate

 yyyy-MM-ddTHH24:mm:ss Tahsilat tarihi

TransactionId

 Integer İşlem id

TransactionStatusCode

 Integer Hareket durum kodu
1: Başarılı, 2: Hatalı, 3: Yapılacak, 4: İşleniyor, 5: İşlem Yapılmayacak, 6: Kontrol Edilecek

AccountCardNumber

 String Hesap/Maskeli kart numarası


Mesaj Kodları

Mesaj Kodu Açıklama

ACBH000025

Başlangıç tarihi formatı hatalıdır.

ACBH000026

Bitiş tarihi formatı hatalıdır.

ACBH000100

Başlangıç tarihi bitiş tarihinden büyük olamaz.

ACBH000134

Tarih aralığı maksimum 1 yıl olmalıdır.

ACBH000153

Geçiş bulunamadı.

ACBH000174

İlgili işlem bireysel müşteri numarası ile yapılamaz.

ACBH000228

Ürün numarası boş olamaz.

ACBH000229

Ürün numarası uygun formatta girilmelidir.

ACBH000248

Başlangıç tarihi boş olamaz.

ACBH000249

Bitiş tarihi boş olamaz.

Örnek

İstek:

{
    "PageNumber": 0,
    "StartDate":"2020-04-21",
    "EndDate" : "2020-05-21",
    "ProductNumber" : "0164157051"
}

Cevap:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "f36f7f97-a763-450e-b2ef-a2743b49ec72"
    },
    "Data": {
        "PassInfo": [
            {
                "NumberPlate": "00AAA00",
                "ExitDate": "2020-04-27T17:31:53",
                "TransactionType": "Geçiş Bedeli",
                "BusinessName": "Karayolları OGS",
                "PaymentDate": "2020-10-15T00:00:00",
                "AccountCardNumber": "5421********1269",
                "ProductNumber": "0164157051",
                "TransactionId": 2020000011669660,
                "TransactionStatusCode": 1,
                "VehicleGrade": 3,
                "PassFee": 29.5,
                "ExitStation": "15 Temmuz Şehitler Köprüsü",
                "EntryStation": "15 Temmuz Şehitler Köprüsü"
            },
            {
                "NumberPlate": "00AAA00",
                "ExitDate": "2020-04-28T10:18:46",
                "TransactionType": "Geçiş Bedeli",
                "BusinessName": "Karayolları OGS",
                "PaymentDate": "2020-10-15T00:00:00",
                "AccountCardNumber": "5421********1269",
                "ProductNumber": "0164157051",
                "TransactionId": 2020000011669643,
                "TransactionStatusCode": 1,
                "VehicleGrade": 3,
                "PassFee": 29.5,
                "ExitStation": "15 Temmuz Şehitler Köprüsü",
                "EntryStation": "15 Temmuz Şehitler Köprüsü"
            }
        ]
    }
}