BalanceInquiry

Message category	Class	Direction
`BalanceInquiry`	Service	ECR → terminal

📘
Used in these guides
Loyalty and card acquisition · Gift cards

Requests the balance of a card, normally a stored value card (prepaid card, giftcard).

A CardAcquisition first is optional (since guide version 1.12). If you send one, leave PaymentType out of the CardAcquisition request.

Example request and response

balanceinquiry

All fields

Example request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "BalanceInquiry",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "BalanceInquiryRequest": {
      "AeAccessibilityMode": true
    }
  }
}

Field	Required	Description
`BalanceInquiryRequest`	Required	Contains the fields below
↳ `AeAccessibilityMode`	Optional	Boolean. Enable accessibility mode for transaction. Default is false.

Example BalanceInquiry response

{
  "SaleToPOIResponse": {
    "MessageHeader": {
      "MessageCategory": "BalanceInquiry",
      "MessageClass": "Service",
      "MessageType": "Response",
      "POIID": "AT12345",
      "ProtocolVersion": "3.1",
      "SaleID": "ECR123",
      "ServiceID": "2"
    },
    "BalanceInquiryResponse": {
      "Response": {
        "AeStan": "123456",
        "AeAcquirerResponseCode": "00",
        "AeResponseCode": "000",
        "AdditionalResponse": "",
        "Result": "Success"
      },
      "PaymentAccountStatus": {
        "PaymentInstrumentData": {
          "PaymentInstrumentType": "Card",
          "CardData": {
            "SensitiveCardData": {
              "ExpiryDate": "2701"
            },
            "CardCountryCode": "578",
            "MaskedPAN": "123481******1761",
            "PaymentBrand": "Giftcard1"
          }
        },
        "CurrentBalance": 123.45,
        "Currency": "EUR"
      }
    }
  }
}

Field	Required	Description
`BalanceInquiryResponse`	Required	Contains the fields below
↳ `Response`	Required	Same layout as in every response. See the example responses on Payment and the example error response on Login
↳ `PaymentAccountStatus`	Required	Contains the fields below
↳ `PaymentInstrumentData`	Optional	Similar to Payment response
↳ `CurrentBalance`	Optional	Balance of the stored value card.
↳ `Currency`	Optional	Currency of the stored value card.