HGS Inquire Passing

This API returns customer authorized product passing informations. Each page has maximum 1000 records. Start and end date range must be maximum 1 year.

API Information

URL

/FPSInquirePass

Method

POST

Version

1.0

Scope

payment

Authorization Flow

Authorization Code


Input Information

Name Format Description Required/Optional

ProductNumber

String Product number Required

StartDate

yyyy-MM-dd Start date Required

EndDate

yyyy-MM-dd End date Required

PageNumber

Integer Page number
Every page has maximum 1000 records. Default value is “0”.
Optional


Output Information

List< PassInfo >

Name Format Description

ProductNumber

Integer Product number

NumberPlate

String Plate number

VehicleGrade

Integer Vehicle grade

EntryStation

String Entry station

ExitStation

String Exit station

ExitDate

yyyy-MM-ddTHH24:mm:ss Exit date

BusinessName

String Business name

TransactionType

String Transaction type

PassFee

Decimal Pass fee

PaymentDate

yyyy-MM-ddTHH24:mm:ss Payment date

TransactionId

Integer Transaction id

TransactionStatusCode

Integer Transaction status code
1: Success, 2: Incorrect, 3: To do, 4: Processing, 5: Will not be done, 6: Will check

AccountCardNumber

String Account/Masked credit card number


Message Codes

Message Code Description

ACBH000025

Start date format is incorrect.

ACBH000026

Ending date format is incorrect.

ACBH000100

Start date cannot be greater than end date.

ACBH000134

Date range must be maximum 1 year.

ACBH000153

Passing cannot be found.

ACBH000174

Transaction cannot be performed with retail customer.

ACBH000228

Product number cannot be empty.

ACBH000229

Product number format is incorrect.

ACBH000248

Start date cannot be empty.

ACBH000249

End date cannot be empty.

Example

Request:

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

Response:

{
    "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ü"
            }
        ]
    }
}