We are using cookies in our website in order to offer better service to you. You allow us to use cookies by continuing to use our internet website. You can reach the detailed information on cookies from our Privacy Policy and Cookies Policy.
X
Home > Api Products > HGS

HGS

Description

Transitions

This API retrieves the customer’s monthly HGS transitions by HGS product number or plate.

How it Works​

Sample Request by Product Number

GET /api/isbank/hgs/v1/transitions?start_date=2019-07-01&end_date=2019-07-31&product_number=100001&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json​

Sample Request by Plate

GET /api/isbank/hgs/v1/transitions?start_date=2019-07-01&end_date=2019-07-31&plate=34ABC123&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json​

Payments

This API retrieves the customer’s monthly HGS payments by HGS product number or plate.​

How it Works​

Sample Request by Product Number

GET /api/isbank/hgs/v1/payments?start_date=2019-07-01&end_date=2019-07-31&product_number=100001&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json

Sample Request by Plate

GET /api/isbank/hgs/v1/payments?start_date=2019-07-01&end_date=2019-07-31&plate=34ABC123&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json

Statements

This API retrieves the customer’s monthly HGS transitions and HGS payments by HGS product number or plate.​

How it Works

Sample Request by Product Number

GET /api/isbank/hgs/v1/statements?start_date=2019-07-01&end_date=2019-07-31&product_number=100001&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json

Sample Request by Plate

GET /api/HGS/v1/statements?start_date=2019-07-01&end_date=2019-07-31&plate=34ABC123&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json

Products

This API retrieves the balance and status information of customer’s HGS products by HGS product number or plate.

Sample Request by Product Number

GET /api/isbank/hgs/v1/products?product_number=100001&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json

Sample Request by Plate

GET /api/isbank/hgs/v1/products?plate=34ABC123&offset=0&limit=100

Headers:
X-IBM-client-id: {YOUR_CLEINT_ID} 
X-IBM-client-secret: {YOUR_CLEINT_SECRET} 
Authorization: Bearer {access_token}
Content-Type: application/json


Sample Response

​Sample Response for Transitions

{
    "data": [
        {
            "product_number": "100001",
            "plate": "34ABC123",
            "transaction_type": "Geçiş",
            "transaction_date": "2019-07-10T10:29:18.35",
            "entry_date": "2019-07-08T12:59:29",
            "entry_place": "AVCILAR",
            "exit_date": "2019-07-08T13:01:45",
            "exit_place": "ESENYURT",
            "transaction_amount": 4.25,
            "balance": 113.65,
            "nickname": "",
            "balance_date": "2019-07-10T10:52:48.990"
        }
    ]
}

Sample Response Payments

{
    "data": [
        {
            "product_number": "100001",
            "plate": "34ABC123",
            "transaction_type": "Yükleme",
            "transaction_date": "2019-07-25T18:40:38.43",
            "entry_date": "0001-01-01T00:00:00",
            "entry_place": "",
            "exit_date": "0001-01-01T00:00:00",
            "exit_place": "",
            "transaction_amount": 30.00,
            "balance": 143.65,
            "nickname": "",
            "balance_date": "2019-07-25T18:40:38.43"
        }
    ]
}

Sample Response Statements

{
    "data": [
        {
            "product_number": "100001",
            "plate": "34ABC123",
            "transaction_type": "Geçiş",
            "transaction_date": "2019-07-10T10:29:18.35",
            "entry_date": "2019-07-08T12:59:29",
            "entry_place": "AVCILAR",
            "exit_date": "2019-07-08T13:01:45",
            "exit_place": "ESENYURT",
            "transaction_amount": 4.25,
            "balance": 113.65,
            "nickname": "",
            "balance_date": "2019-07-10T10:52:48.990"
        },
        {
            "product_number": "100001",
            "plate": "34ABC123",
            "transaction_type": "Yükleme",
            "transaction_date": "2019-07-25T18:40:38.43",
            "entry_date": "0001-01-01T00:00:00",
            "entry_place": "",
            "exit_date": "0001-01-01T00:00:00",
            "exit_place": "",
            "transaction_amount": 30.00,
            "balance": 143.65,
            "nickname": "",
            "balance_date": "2019-07-25T18:40:38.43"
        }
    ]

Sample Response Products

{
    "data": [
        {
            "product_number": "100001",
            "plate": "34ABC123",
            "balance": 143.65,
            "status": 1
        },
        {
            "product_number": "100002",
            "plate": "34ABC012",
            "balance": 0.00,
            "status": 2
        }
    ]
}​