Balance inquiry

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

Example request

{
  "SaleToPOIRequest": {
    "MessageHeader": {
      "ProtocolVersion": "3.1",
      "ServiceID": "2",
      "MessageClass": "Service",
      "MessageCategory": "BalanceInquiry",
      "MessageType": "Request",
      "SaleID": "ECR123",
      "POIID": "AT12345"
    },
    "BalanceInquiryRequest": {
      "AeAccessibilityMode": true
    }
  }
}
PropertyDescriptionMandatory / Optional
BalanceInquiryRequestMandatory
AeAccessibilityModeBoolean. Enable accessibility mode for transaction. Default is false.Optional

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"
      }  
    }
  }
}
PropertyDescriptionMandatory / Optional
BalanceInquiryResponseMandatory
ResponseMandatory
PaymentAccountStatusMandatory
PaymentInstrumentDataSimilar to Payment responseOptional
CurrentBalanceBalance of the stored value card.Optional
CurrencyCurrency of the stored value card.Optional

Did this page help you?