HGS Inquire Balance and Transaction

This API returns customer’s authorized HGS product balance and transaction Each page has maxiımum 1000 records. Start and end date must be maximum 1 year.

API Information

URL

/FPSInquireBalanceTransaction

Method

POST

Version

1.0

Scope

payment

Authorization Flow

Authorization Code


Input Information

Name Format Description Required/Optional

PassProductID

Integer Pass product id 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

TransactionStatusCode

Integer Transaction status code
1:All, 2:Success, 3:Incorrect
Optional


Output Information

List< BalanceTransactionInfo >

Name Format Description

ProductNumber

Integer Product number

ProductType

Integer Product type
1: HGS, 2: OGS

NumberPlate

String Plate number

AccountCardNumber

String Account/Masked credit card number

AccountType

Integer Account type
1: Account, 2: Credit Card

TransactionAmount

Decimal Transaction amount

NewBalance

Decimal Balance

TransactionId

Integer Transaction id

TransactionType

Integer Transaction type

TransactionTypeDescription

String Transaction type description

Description

String Detailed transaction description

CurrencyCode

String Currency type

TransactionStatusCode

Integer Transaction status code

TransactionDate

yyyy-MM-ddTHH24:mm:ss Transaction date


Message Codes

Message Code Description

ACBH000025

Start date format is incorrect.

ACBH000026

End date format is incorrect.

ACBH000100

Start date cannot be grater than end date.

ACBH000134

Date range must be maximum 1 year.

ACBH000137

Product does not belong to customer in session.

ACBH000154

Transaction cannot be found.

ACBH000174

Transaction cannot be performed with retail customer.

ACBH000247

Transaction status code is invalid.

ACBH000248

Start date cannot be empty.

ACBH000249

End date cannot be empty.

Example

Request:

{
  "TransactionStatusCode": 1,
    "StartDate":"2018-02-14",
    "EndDate" : "2018-02-15",
    "PageNumber" : 0,
    "PassProductID":141003
}

Response:

{
    "Header": {
        "StatusCode": "APIGW000000",
        "StatusDescription": "Completed",
        "ObjectID": "10477f97-a763-450e-b2ef-a2743b49ec72"
    },
    "Data": {
        "BalanceTransactionInfo": {
            "NumberPlate": "00AAA00",
            "TransactionType": 10,
            "Description": "HGS Müşteri No: 43210, HGS Etiket No: 1106504486, Plaka No:00AAA00,  Satış Ücreti: 15,00, İlk Yükleme Tutarı:50,00, HGS Satış ve İlk Dolum Tahsilatı",
            "AccountCardNumber": "5421********1604",
            "ProductType": 1,
            "ProductNumber": 1106504486,
            "AccountType": 1,
            "TransactionId": 2018000000649002,
            "TransactionAmount": 50,
            "CurrencyCode": "TL",
            "NewBalance": 50,
            "TransactionTypeDescription": "Satış İşlemi",
            "TransactionStatusCode": 1,
            "TransactionDate": "2018-02-14T16:25:46"
        }
    }
}