HGS Inquire Product

This API returns customer’s authorized products of passing system. Maximum 2000 recorcd can list each request.

API Information

URL

/FPSInquireProduct

Method

POST

Version

1.0

Scope

payment

Authorization Flow

Authorization Code


Input Information

Name Format Description Required/Optional

PageNumber

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

ProductStatusCode

Integer Pruduct status code
0: All, 1: Active, 2:Cancelled Product, 3: Cancelled Sale, 4: Low Credit, 5: Black List
Optional

NumberPlate

String Plate number Optional

ProductNumber

String Number of HGS/OGS product Optional


Output Information

List< ProductInfo >

Name Format Description

PassProductID

Integer Pass product id

ProductNumber

Integer Product number

ProductType

Integer Product type
1: HGS, 2: OGS

NumberPlate

String Plate number

AccountCardNumber

String Account/Masked card number

AccountType

Integer Account type
1: Account, 2: Credit Card

Balance

Decimal Balance

ProductStatusCode

Integer Product status code

VehicleGrade

Integer Vehicle grade

ProductSaleDate

yyyy-MM-ddTHH24:mm:ss Product sale date

ProductCancelDate

yyyy-MM-ddTHH24:mm:ss Product cancel date


Message Codes

Message Code Description

ACBH000152

Product cannot be found.

ACBH000174

Transactin cannot be performed by retail customer number.

ACBH000246

Product status code is invalid.

Example

Request:

{
    "PageNumber": 0,
    "ProductStatusCode": 0,
    "NumberPlate" : "",
    "ProductNumber" : "1111111632"
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "8df104b5-5862-4df0-ae35-894c85b5637a"
    },
    "Data": {
        "ProductInfo": {
            "NumberPlate": "WEREWWREWRE",
            "PassProductID": 370010,
            "ProductSaleDate": "2020-07-22T10:59:24",
            "AccountCardNumber": "00158000000000001",
            "ProductStatusCode": 1,
            "VehicleGrade": 4,
            "ProductType": 1,
            "ProductNumber": 1111111632,
            "AccountType": 1,
            "Balance": 90
        }
    }
}